WhatsApp Client

The IWhatsApp interface is for working with a WhatsApp Connector to a companies' WhatsApp Business Account.

To create an IWhatsApp instance, the static Create() function needs to be called. Two existing ISocketProvider (TCP and TLS) as well as an IDns instance must be passed to Create(). These instances must not be deleted before releasing the IWhatsApp instance!

File information

Classes

    class IWhatsAppClient {
    public:
    static IWhatsAppClient * Create(class IIoMux * const iomux,
    class UWhatsAppClient * const user,
    class ISocketProvider * const tcpSocketProvider,
    class ISocketProvider * const tlsSocketProvider,
    class IInstanceLog * const log,
    class IDns * const dns,
    class ISocketContext const socketContext = nullptr
    );

    virtual ~IWhatsAppClient() {}
    virtual void Close() = 0;
    virtual void SetConfig(const char * token, const char * secret) = 0;
    virtual void SetWebhookToken(const char* webhookToken) = 0;
    virtual void SendMessage(UWhatsAppClient * context, json_io value, word base, const char * remoteNum, const char * type, const char * channel, const char * callback_info=0, const char * refersToID = 0) = 0;
    virtual void RequestMedia(UWhatsAppClient * context, const char* destination, const char* mediaID, const char* detailsType) = 0;
    virtual const char* GetVersion() = 0;
    };

Overview

Public functions

    class UWhatsAppClient {
    public:
    virtual ~UWhatsAppClient() {};
    virtual void WhatsAppClientCloseComplete(IWhatsAppClient * const whatsappClient) = 0;
    virtual void WhatsAppClientSendMessageResult(IWhatsAppClient * const whatsappClient, whatsapp_error_t error, const char * callback_info = 0, const char * content = 0) = 0;
    virtual void WhatsAppClientRecvMessage(IWhatsAppClient* const whatsappClient, const char* msg, const char* tel, const char * channel, const char * type, const char * id, const char * refersToID = 0) = 0;
    virtual void WhatsAppClientRecvMedia(IWhatsAppClient* const whatsAppClient, const char* sender, const char* channel, const char* wamid, const char* mediaid, const char* mimeType) = 0;
    };

Overview

Public functions

    class IWhatsAppOnboarding {
    public:
    static IWhatsAppClient * Create(class IIoMux * const iomux,
    class UWhatsAppOnboarding * const user,
    class ISocketProvider * const tcpSocketProvider,
    class ISocketProvider * const tlsSocketProvider,
    class IInstanceLog * const log,
    class IDns * const dns,
    class ISocketContext const socketContext = nullptr
    );

    virtual ~IWhatsAppOnboarding() {}
    virtual void Close() = 0;
    virtual void Onboard(UWhatsAppOnbaording * context, const char* src, const char* vrsion, const char* code, const char* webhookToken, const char* wabaID, const char* callbackUri, const char* phoneID, const char* phonePin) = 0;
    };

Overview

Public functions

    class UWhatsAppOnboarding {
    public:

    virtual ~UWhatsAppOnboarding() {}
    virtual void WhatsAppOnboardingCloseComplete(IWhatsAppOnboarding * const onboarding) = 0;
    virtual void WhatsAppOnboardingOnboardResult(IWhatsAppOnbaording * const onboarding, const char* callback_info, onboardingStatus status, const char* token = 0) = 0;
    };

Overview

Public functions

Data types

whatsapp_error_t

    typedef enum {
    WHATSAPP_ERR_OK = 0,
    WHATSAPP_ERR_MISSING_TOKEN,
    WHATSAPP_ERR_MISSING_VERSION,
    WHATSAPP_ERR_NOT_FOUND,
    WHATSAPP_ERR_BAD_REQUEST,
    WHATSAPP_ERR_AUTHENTICATION_FAILED,
    WHATSAPP_ERR_OTHER_HTTP,
    WHATSAPP_ERR_CLOSING
    } whatsapp_error_t;

This enum defines the possible outcomes for sending a message via the connector. One of them will be returned at UWhatsAppClient::WhatsAppClientSendMessageResult.

onboardingStatus

    typedef enum {
    UNSTARTED,
    FETCH_TOKEN,
    REGISTER_WEBHOOKS,
    REGISTER_PHONE,
    FINISHED
    } onboardingStatus;

This enum defines the possible outcomes for an onboarding. Stages are passed from Top to Bottom, signaling the failing stage if onboarding could not completely finished, allowing further follow-up for only the unfinished stages.

Getting the Data

Code Example

IWhatsAppClient

    app::app(class IIoMux * iomux,
    ISocketProvider * tcpSocketProvider,
    ISocketProvider * tlsSocketProvider,
    IDns * dns,
    IInstanceLog * log)
    : iomux(iomux)
    {
        this->client = IWhatsAppClient::Create(iomux,
                                                this,
                                                webserverPlugin,
                                                tcpSocketProvider,
                                                tlsSocketProvider,
                                                this,
                                                dns);
    isTerminating = false;
    }

    void WhatsApp::Stop(){
    if (!isTerminating) {
        isTerminating = true;
        if (client != nullptr) client->Close();
        TryStop();
        }
    }

    void WhatsApp::TryStop(){
        if (isTerminating && client == nullptr) appService->AppStopped(this);
    }



    void app::WhatsAppClientCloseComplete(IWhatsAppClient* const whatsappClient){
        delete client;
        client = nullptr;
        TryStop();
    }

    void app::WhatsAppClientSendMessageResult(IWhatsAppClient* const whatsappClient, whatsapp_error_t error){
        //can ignore the result or act according to it
    }