Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 2.91 KB

README.md

File metadata and controls

107 lines (75 loc) · 2.91 KB
Raw

Medusa-Plugin-Whatsapp

Bring two poplar platforms together

Getting started

Installation

yarn add medusa-plugin-whatsapp

Usage

Api

Configure the sandbox webhook to point to http://yourserver/whatsapp/received

License

MIT

Configuration

set the following environment variables. Please use production codes, Test codes don't work with the whatsapp sandbox

TWILIO_AUTH_SID= <your twilio auth code> // it begins with AC
TWILIO_AUTH_TOKEN= <your twilio auth token>

#### Only for testing
TEST_SEND_NUMBER= <sandbox number>
TEST_RECIEVER_NUMBER= <your sandbox member number>

in medusa-config.js

add to your plugins list

///...other plugins
  {
     resolve:"medusa-plugin-whatsapp":
    {
      options:{
      account_sid: process.env.TWILIO_AUTH_SID,
      auth_token: process.env.TWILIO_AUTH_TOKEN,
      whatsappHandlerInterface:"nameOftheHandlerService"
      }
    }

  }

the whatsapp handler service need to implement the interface - WhatsappHandlerInterface

eg :

// please note you'll have to configure the message receive hooks in twilio to point to <Your server url>/whatsapp/received

export default class myService implements WhatsappHandlerInterface {

  whatsappHandler (container: MedusaContainer, body: T, activeSession: WhatsappSession):Promise<MessagingResponse>; {
    // your code to process the incoming message
  }

// please note you'll have to configure the global conversation hooks in twilio to point to <Your server url>/whatsapp/prepare


whatsappConversationPrehookHandler: (
    container: MedusaContainer,
    body: T,
    activeSession?: WhatsappSession
  ) => Promise<
    | {
        body?: string;
        author?: string;
        attributes?: Record<string, string>;
      }
    | { friendly_name?: string }>
  {
    // your code to handle the incoming conversation message
  }

similarly the conversation posthookhandler can be configured with the post hook in twilio pointing to <Your server url>/whatsapp/do

whatsappConversationPosthookHandler (container: MedusaContainer, body: T, activeSession?,WhatsappSession) => Promise<{
        body?: string;
        author?: string;
        attributes?: Record<string, string>;
    } | {
        friendly_name?: string;
    }>{
      // your code

    }

}

Sponsorship

If you find the Medusa-Plugin-Whatsapp valuable and would like to support its development, consider sponsoring us on GitHub. Your sponsorship will help us continue to improve and maintain this plugin, bringing two popular platforms together.

By sponsoring, you'll gain access to exclusive benefits and features, and you'll be making a difference in the developer community. Help us shape the future of this plugin by sponsoring today and will help facilitating more open source contributions from me.

Sponsor