# Maytapi

![Maytapi Unofficial WhatsApp API](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FpuFBdSAlDCZgPTl9kBYK%2FMaytapi%20Unofficial%20WhatsApp%20API.png?alt=media\&token=e9927855-05c9-4938-8b08-5cdd98baa055)

Maytapi Unofficial WhatsApp API for Developers allows you to connect your WhatsApp to RUM Work easily. It doesn't require approval from WhatsApp and only takes a few minutes to integrate both platforms. So, you don't have to wait to communicate with your customers on WhatsApp using the RUM Work platform.

Simply follow the below steps to create a RUM Work Maytapi Channel for WhatsApp.

{% hint style="success" %}
You can use either WhatsApp Business or Personal number to utilize the Maytapi Unofficial WhatsApp API.
{% endhint %}

{% embed url="<https://youtu.be/-YbQvlF15oI>" %}

Prefer watching a video? Then hit the play button above. Or, continue with the following.

### Step 1 - Sign Up for Maytapi Unofficial WhatsApp API

Visit [Maytapi](https://maytapi.com/) to register and create your account by clicking the *Start Free Trial*.

![Maytapi Platform](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FW7E1rIZGT7URk0F3YIvd%2FMaytapi%20Homepage.png?alt=media\&token=4aff66cb-29ab-457d-b164-5bc4f4573101)

This will open a new page asking for a few details to register on the Maytapi platform.&#x20;

![Registering at Maytapi](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FsOGZH64a6d2InZaaibdw%2FCreating%20an%20Account%20at%20Maytapi.png?alt=media\&token=47125558-1d83-4969-8a92-598c1fdd8864)

Enter the details, accept the Terms of Service and Privacy Policy, and continue by tapping the *Register* button. As soon as you click the button, the platform will create your account and show a popup asking you to Logout or Start Trial.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FpyNc9QUgT0nUrNWpiium%2FStarting%20trial%20at%20Maytapi.png?alt=media\&token=7e7bfad5-9705-4122-8f2e-de86c9fd9811)

Click *Start Trial* and you'll enter the platform like the following.

![Maytapi New Registration](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2F4JHzJlcwU8O5DFzyHuLr%2FMaytapi%20Window%20after%20registration.png?alt=media\&token=6b72cf00-7c5e-4ae9-abed-b0cc219e6361)

### Step 2 - Add a New Phone to Maytapi

For Maytapi RUM Channel to work, you must first add a new phone to the Maytapi interface. And to do that,

* Click *Add New Phone* in your Maytapi window. This will take a few moments to generate the instance.&#x20;

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FOTUa2aVZGo0f3Z81KPVR%2FNew%20Phone%20Added%20to%20the%20Maytapi%20WhatsApp%20API.gif?alt=media\&token=839a34c6-1054-46ff-917e-91a5079b5650)

Once the process is completed, move to Step 3.&#x20;

### Step 3 - Create a Maytapi Channel at RUM Work for WhatsApp

Now, to connect Maytapi Unofficial WhatsApp API to RUM Work, you need to create a channel. This will allow you to communicate with customers over WhatsApp from RUM Work. To do that, first,&#x20;

* Login to RUM Work.&#x20;
* Then, go to **Channels**.&#x20;
* There, click **Configure** for the Maytapi channel. Or you can click, *Create Channel* if there are already channels.

![Configuring Maytapi Channel](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FhR4B07TMMuTAZky70ELC%2FConfiguring%20Maytapi%20Channel.png?alt=media\&token=5d55f4ce-a5ac-4be3-9afb-b1370318cebc)

Upon clicking the Configure button, a popup will appear asking for a few details to finish creating the channel.&#x20;

![Maytapi Channel Information Required by RUM Work](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FOiwsyJshop2mXb4OFPre%2FDetails%20required%20for%20the%20Maytapi%20channel.png?alt=media\&token=efe13c33-e948-41fc-a567-d2c2a608b629)

The details are,

* Title = you can set the title as you want to recognise the channel.
* Product ID.
* Product Token.
* And Phone ID.

Apart from the Title, for the remaining details, you need to open the Maytapi platform, where you've just added a new phone.

In the Maytapi account, go to the **Product ID & Token**, and copy the details.&#x20;

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FxvTmieJ0GZTOVW6xoIoq%2FCopying%20Product%20ID%20and%20Token%20at%20Maytapi.png?alt=media\&token=148b398b-8265-40cc-be2d-e9600c358fa6)

For Phone ID, go to the **Phones**, and copy the ID mentioned in the *Registered Phones* section.&#x20;

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FtmOb7rBxhRESg3zxSHsA%2FCopying%20Maytapi%20Phone%20ID%20for%20RUM%20Work%20Channel%20to%20work.png?alt=media\&token=61b8b601-15a4-445a-b916-e2ac9d088bc6)

Once you've got all the details, head back to RUM Work, and enter them where they're needed.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2F7Hh4aqAEQqcSPDQTCgsZ%2FEntering%20Details%20for%20the%20Maytapi%20channel%20at%20RUM%20Work.png?alt=media\&token=9525d193-2840-4cf0-8861-81cbbab52231)

{% hint style="info" %}
You need to repeat the steps to copy and paste the details one by one, individually. First, for the Product ID, then Token, and in the end, Phone ID.
{% endhint %}

After entering all the details, you can click *Finish*, and that's it; you've created the Maytapi Unofficial WhatsApp API channel.&#x20;

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FLH3aQEIEEFRRUCiMQzA2%2FCreated%20Maytapi%20Channel%20at%20RUM%20Work%20channels%20list.png?alt=media\&token=97d90fef-f55d-4036-906c-b184f3ea5450)

However, it's not connected to the WhatsApp account you're using. So, for that, you need to follow a few more steps.&#x20;

* Click on the **Details** button on your channel.&#x20;

![Accessing RUM Work Maytapi Channel's Phone Settings](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FFVIuFaaBBf2ld5CSaKl9%2FAccessing%20Maytapi%20RUM%20Work%20Details%20option.png?alt=media\&token=4272994f-4093-46a7-b721-2a0ab152c2a3)

This will open the Phone Settings where you can see the WHATSAPP WEB banner.&#x20;

![QR Code to Connect WhatsAPP to RUM Work](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FnCj1QVtM2nNCRKvbWcg6%2FQR%20Code%20Window%20for%20Maytapi%20RUM%20Work%20Channel.png?alt=media\&token=99d57a82-fe65-435e-880d-90d48c319d1d)

You need to scan the code visible in the banner from your mobile application. Follow the below steps to learn how to scan a QR code in WhatsApp to use it on a computer.

1. Open WhatsApp → tap [**More options**](https://faq.whatsapp.com/android/troubleshooting/finding-the-more-options-icon)<img src="https://scontent.whatsapp.net/v/t39.8562-34/118117430_995065920932265_1336446442210986426_n.jpg?stp=cp0_dst-jpg_e10_p50x50&#x26;ccb=1-7&#x26;_nc_sid=8a74b9&#x26;_nc_ohc=TMWashz5jlwAX9N_zzW&#x26;_nc_ht=scontent.whatsapp.net&#x26;oh=01_AVyM8UTti6ExrcYyWJ1UIeWcBrQ2bIFVuj_BZmqe03-8wQ&#x26;oe=62C97BDF" alt="" data-size="line"> → **Settings**. The main settings of your WhatsApp application.
2. Tap the **QR** icon (top right corner) displayed next to your name.
3. Select **SCAN CODE**.
4. Hold your device over the QR code to scan.
5. An alert will appear, *Device login code detected*, select **CONTINUE**.
6. Click **LINK A DEVICE.**
7. And scan the code again to complete the linking.

After successfully linking your WhatsApp to RUM Work Maytapi Channel, you'll be able to see your WhatsApp conversations.

![WhatsApp Web Screen in RUM Work](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2Frm7AK5b8C0h3whX8nLxj%2FWhatsApp%20Maytapi%20Channel%20Conversations%20in%20Rum%20Work.png?alt=media\&token=6ab1dff6-c6e5-40ec-8504-89eaadf53441)

And that's it; you've created a WhatsApp Channel in RUM Work using the Maytapi Unofficial WhatsApp API.

![Connected Maytapi RUM Work WhatsApp Channel](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FUXdbJrWlINx2YRFWOMbK%2FConnected%20Channel%20in%20RUM%20Work%20for%20Maytapi.png?alt=media\&token=c48c804e-33ec-4a38-98eb-a23f994f4f47)

You'll see the *Connected* status in your Channels window, ensuring you can now communicate with your customers through the RUM Work Chat interface.

### Channel Configuration

Utilise additional settings of the Maytapi channel to optimize its use.

#### Phone Settings

The Phone Settings of the Maytapi Channel lets you align the WhatsApp API correctly. To access it, go to **Details** on the channel.

![Opening RUM Work Maytapi Channel's Phone Settings](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FX7yO1RSU1RfQNqHYA8Sg%2FOpening%20Phone%20Settings%20for%20Maytapi.png?alt=media\&token=093f6206-995c-49ca-a201-efb0ed2da58d)

This will open the following window with the WhatsApp screen and other controls.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FZKpAExoe2Zh5WRdp0RlB%2FPhone%20Settings%20of%20Maytapi%20Channel.png?alt=media\&token=c38f582b-7de6-48a0-a48b-e1c310a8f0f1)

Here, you can view the Channel ID and copy it using the Copy icon.&#x20;

![Phone Settings Other Controls](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FYQ4DHlWZgzQYO3a3OLUD%2FMaytapi%20Phone%20Settings%20Other%20Controls.png?alt=media\&token=0bf876de-f9e4-4126-a9b0-bfbd65cd3311)

Other controls let you perform actions as follows,&#x20;

* <img src="https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FN4SMg0QrU61J4ZCOq74v%2FRefresh%20API%20Connection%20Instance.png?alt=media&#x26;token=bee2e12a-7c50-4d15-84e8-72e63e4eba5c" alt="" data-size="line"> = **Restart API Instance**: Use it to Refresh the connectio&#x6E;**.**
* <img src="https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2Fc4hLRYBACxGiIkx7aqOz%2FSync%20Contacts.png?alt=media&#x26;token=b84ad708-5bd4-438f-9007-e02471ffa443" alt="" data-size="line"> = **Sync Contacts.**
* <img src="https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FrbJELeN3efbVQ152O7NU%2FSync%20Messages.png?alt=media&#x26;token=d3c6bb5e-57df-4d39-aba5-28b49f262340" alt="" data-size="line"> = **Sync Messages**.
* <img src="https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FEw3MvXYlkLT8d5cd9o0u%2FLogout.png?alt=media&#x26;token=e1d14622-eccf-466b-9e62-390c514e5011" alt="" data-size="line"> = **Logout**: Use it to log out from the current WhatsApp connection.
* <img src="https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FOAC2hTvroCSUtwfRE0GP%2FDelete%20the%20Channel.png?alt=media&#x26;token=684f22b0-1405-448d-944f-9cfb7bad350d" alt="" data-size="line"> = **Delete Channel**.

#### Store Settings

Through WhatsApp chat, if you want to process orders and payments, you can utilize the WhatsApp Store Settings. To access the controls, click on **Store Settings**.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2Fm2GpYkqj5UyzavxlRpR1%2FWhatsApp%20Store%20Settings%20of%20Maytapi%20Channel%20through%20Store%20Settings.png?alt=media\&token=e9ed6683-1cd5-4468-a275-904d9c1c77e4)

This will open the following window with several fields and options.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FR1T5sLpS7ubknuddUgzJ%2FWhatsApp%20Store%20Settings%20Page%20of%20Maytapi%20Channel.png?alt=media\&token=1110e852-7b7b-4844-b901-bb190b67ded6)

The options available are,

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FhkhCFOaGVSruOESQLACT%2FSelect%20Payment%20Partner%20Field%20in%20Maytapi%20Channel.png?alt=media\&token=9b047d86-2eba-4968-bf4f-69a364d33de6)

* **Select Payment Partner** - This allows you to choose the payment processor.&#x20;

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FqdTxw80bhT2NfDcVroJf%2FSelect%20Default%20Currency%20in%20Maytapi%20Channel.png?alt=media\&token=0689a1cd-328c-4918-a108-d19883f00278)

* **Select Default Currency** - What currency do you want to charge your customers: *USD or HKD*.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FxuDF0jfFn4M21s7vQVPA%2FTest%20Mode%20and%20Live%20Mode%20for%20the%20Maytapi%20Channel.png?alt=media\&token=6b87c644-f633-4607-a40f-7a64133cffb9)

* **Test Mode or Live Mode** - The payment processor offers Live and Test Mode keys. Using this option, you can put the store on either Live or Test mode. If you're testing the payment processor, use the Test mode and its keys. Otherwise, choose the Live Mode.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FbfydgRQjGqWFtby8sbxd%2FStripe%20Publish%20and%20Secrect%20Key%20Fields.png?alt=media\&token=3ed90863-aafa-4e10-9f59-de05b81781f8)

* **Stripe Publish Key** - Use it to enter your Stripe Publish Key based on the mode. Get it [here](https://dashboard.stripe.com/apikeys).
* **Stripe Secret Key** - Use it to enter Stripe Secret Key based on the mode. Get it [here](https://dashboard.stripe.com/apikeys).

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FeztH4kaXfQKGz4T1B82o%2FYedpay%20Store%20and%20Access%20Token%20Fields.png?alt=media\&token=4fd9734a-a84a-450b-ba63-e96042c18cbd)

If you've selected Yedpay as your Payment Partner, you'll get the following fields:

* **Yedpay Store ID** - Use it to enter your Yedpay Store ID based on the mode. Get your Yedpay Store ID [here](https://merchant.yedpay.com/admin/stores).
* **Yedpay Access Token** - Use it to enter your Yedpay Access Token based on the mode. Get your Yedpay Access Token [here](https://merchant.yedpay.com/user/my-personal-token).

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FwMv4nHornQnY50WL8t23%2FMpay%20Fields%20for%20Maytapi%20Channel.png?alt=media\&token=03438627-59cf-4ae4-8457-cdf79c999fc4)

If you've selected Mpay as your Payment Partner, you'll get the following fields:

* **Select Language** - In what language do you want to enter Mpay details: English/Traditional Chinese/Simplified Chinese.
* **Mpay Merchant ID** - Based on the mode, enter your Merchant ID.&#x20;
* **Mpay Terminal ID** - Based on the mode, enter your Terminal ID.
* **Mpay Secure ID** - Based on the mode, enter your Secure ID.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2F4OYlj4ZJfAi6dhHpUL5G%2FPayment%20Status%20Message%20Fields%20for%20Maytapi%20Channel.png?alt=media\&token=9ccd54d2-24d1-4982-b513-29cd3cf5540a)

* **Payment Success Message**.
* **Payment Failed Message**.
* **Payment Default Message**.

Use the above fields to send customers pre-defined messages based on the payment status.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FOSY5lyNeoptNSbOOQazY%2FSaving%20WhatsApp%20Store%20Settings%20in%20Maytapi%20Channel.png?alt=media\&token=9f7958b5-6006-42e9-be5f-9574093337ec)

Once you're done with the customization, click **Save Payment Settings**.

#### Manage Templates

Different customers often reach out with the same queries, and answering them repeatedly could become overwhelming. Therefore, create Message Templates, and when customers reach out, simply use them.

To create your message templates, click on **Manage Templates**.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FkaXQYiZiUzVz3pq2E9os%2FOpening%20Manage%20Templates%20in%20Maytapi%20Channel.png?alt=media\&token=547643dd-61a0-4c0b-b6fe-04e29907148d)

A new window will appear with a **Create Message Template** button.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2Fhnku9D5w3cYmG3sOQQUg%2FCreating%20a%20Message%20Template%20in%20Maytapi%20Channel.png?alt=media\&token=995fd8c1-8862-41da-86d1-386d8f9a4f69)

Simply click on it and it will bring a popup to create the template.&#x20;

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2F2GePqU089yL7ZoIAJJMK%2FCreate%20Message%20Templates%20Popup%20in%20Maytapi%20Channel.png?alt=media\&token=0601f457-7e88-4f07-bbac-7395df5348d9)

Here, name your template. Insert placeholders to personalise the message. Edit the message or fill the text around placeholders. Use a File, and even provide customers with an option to unsubscribe.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FUL6vuNKigoJ1x0PaJqg1%2FMessage%20Templates%20Library%20in%20Maytapi%20Channel%20for%20WhatsApp.png?alt=media\&token=c9b9872c-1f8d-4054-b21a-6049411c96de)

Once done with the template, click Save, and it will be shown to the message templates library.

#### More Options

In addition to the [Phone Settings](#phone-settings), [Store Settings](#store-settings) and [Message Templates](#manage-templates) there are a few more options you can utilise.

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FPwUAKMB3e4WVQQkcLJNq%2FMaytapi%20Channel%20More%20Options.png?alt=media\&token=7dd19682-7980-44c1-8f20-54570afbaa3e)

* **Edit** - It provides you with the option to change Channel Name; Add Webhook URL and  Disconnection Alert Emails.&#x20;

![](https://1755261872-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhElFPtMZjXYjDDMBT5q2%2Fuploads%2FBV9bk3c5C0Zd65MLnG18%2FEdit%20option%20of%20the%20Maytapi%20Channel.png?alt=media\&token=58247f1e-1fd9-49b5-9785-aaaca53b9def)

* **Delete** - Simply delete the channel.
* **Mark as Default** - You'll see this particular channel as the primary channel in the Chat.
* **Copy Channel ID** - Copy Channel ID without opening the Phone Settings.