Skip to content

Commit 0ca9122

Browse files
sriyanshcsesriyanshcse
authored
Merge branch 'main' into raven-sms-email-docs
2 parents 631e1c7 + 228d23f commit 0ca9122

File tree

6 files changed

+105
-13
lines changed

6 files changed

+105
-13
lines changed

‎docs/in-app/client-sdk/react.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@ description: "Raven In-app SDK lets you add a notification center in your react
55

66
## Setup
77

8+
**Step 1**
9+
810
Before setting up the SDK, please make sure you have followed the steps to [setup the Raven In-App Integration](https://docs.ravenapp.dev/in-app/integrations/raven) first.
911

10-
**Step 1**
12+
**Step 2**
1113

1214
Run the following commands your project root directory.
1315

1416
```bash
1517
npm i @ravenapp/raven-inapp-react
1618
```
1719

18-
**Step 2**
20+
**Step 3**
1921

2022
Inorder to start using InApp React SDK ,intialize library and import InAppNotificationCenter and styles.
2123

‎docs/mint.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,8 @@
116116
"sms/integrations/sinch",
117117
"sms/integrations/route_mobile",
118118
"sms/integrations/raven"
119+
"sms/integrations/2factor",
120+
"sms/integrations/clicksend"
119121
]
120122
}
121123
]

‎docs/sms/integrations/2factor.mdx

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "2Factor"
3+
description: "Guide on how to add 2Factor SMS provider."
4+
---
5+
6+
### Step 1. Account Setup
7+
8+
If you do not have an account with 2Factor yet, you can easily create an account [here](https://2factor.in/v3/free-bulk-sms-service-trial/index.php)\*\*.
9+
10+
To be able to send bulk sms to your clients, as per new TRAI regulations you also need to register on the DLT platform. Follow the steps to register on DLT platform [here](https://www.notion.so/DLT-Registration-Steps-ca272ad868cc4014920a8c964ebd4294) (or 2 factor link [here](http://2factor.in/v3/dlt/trai-mandatory-dlt-registration/))
11+
12+
Once you have registered yourself on DLT and created a 2Factor account, you can then add 2Factor Provider in Raven.
13+
14+
<Note>
15+
If you are sending SMSs in India, TRAI has mandated to register their
16+
business, headers (sender IDs), and templates on any of the DLT platforms.
17+
</Note>
18+
19+
### Step 2. 2Factor Integration in Raven
20+
21+
In the provider form in Raven for 2Factor, you need to fill the following values
22+
23+
| Key | Details |
24+
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
25+
| Api Key | If you are signed up in 2Factor.in, you can get your api key [here](https://2factor.in/CP/Dashboard_list.php) |
26+
| Sender Id | It has to be a preconfigured 6 characters alphabetical sender id for the enterprise account. The Sender ID should be linked with the SMS template as registered on DLT portal. Learn more about DLT Sender Id [here](https://2factor.in/v3/dlt/trai-mandatory-dlt-registration/). Use 'Request Sender Id' option provided under Addon Services >> Transactional SMS >> Request Sender Id. For transactions messages See [here](https://2fa.api-docs.io/v1/send-transactional-sms/create-new-sender-id-for-transactional-sms). For OTP messages see [here](https://2fa.api-docs.io/v1/send-sms-otp/creating-a-custom-otp-template-sender-id) |
27+
| Route | Applicable only for SMSes sent by Indian businesses to Indian destination numbers. Use the route type specified when registering your templates. Possible values: Transactional, OTP, Promotional. |
28+
| DLT Entity ID | Applicable only for SMS sent by Indian businesses to Indian destination numbers. Your Entity Id as registered on DLT (Distributed Ledger Technology) portal of operators in India. This is mandatory to be passed in API or configured on Dashboard for SMSes towards Indian destination. Read more [here](http://2factor.in/v3/dlt/trai-mandatory-dlt-registration/). If you have set up your DLT Management Portal on 2Factor, you can check [here](https://dlt-registration.2factor.in/v0.2/login.php) as well |
29+
30+
### Step 3. Delivery Reports
31+
32+
2Factor provides you with an option to set a callback URl, which is hit by 2Factor system, to acknowledge the status of sent sms. 2Factor Transactional SMS API supports upto 3 callback URLs for receiving SMS delivery reports in Realtime.
33+
34+
Callback URL can be set using Manage Services option provided in control panel.For transactional sms [here](https://2factor.in/CP/more_services_list.php), for sms otp [here](https://2factor.in/CP/otp_account_list.php)
35+
36+
**Advanced**
37+
38+
For some additional references, refere [here](https://2fa.api-docs.io/v1/additional-references)
39+
40+
## 🔗 Links
41+
42+
- [2Factor **Website**](https://2factor.in/v3/?at_category=2factor&at_event_action=spr&service=BULK-SMS-OTP-SERVICE-PROVIDER)
43+
- [2Factor SMS Documentation](https://documenter.getpostman.com/view/301893/TWDamFGh#46b8df37-b085-45e0-9dae-ce6b52f722c9)
44+
- [2Factor Main Dashboard](https://2factor.in/CP/menu.php)
45+
- [Additional References](https://2fa.api-docs.io/v1/additional-references)
46+
47+
<Info>
48+
If you are facing issues with this integration or find something missing,
49+
please write to us at support@ravenapp.dev
50+
</Info>

‎docs/sms/integrations/clicksend.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "ClickSend"
3+
description: "Guide on how to add ClickSend SMS Integration."
4+
---
5+
6+
### Step 1. Account Setup
7+
8+
If you do not have an account with ClickSend yet, you can easily create an account [here](https://dashboard.clicksend.com/signup/step1).
9+
10+
To be able to send bulk sms to your clients, as per new TRAI regulations you also need to register on the DLT platform. Follow the steps to register on DLT platform [here](https://www.notion.so/DLT-Registration-Steps-ca272ad868cc4014920a8c964ebd4294)
11+
12+
Once you have registered yourself on DLT and created a ClickSend account, you can then add ClickSend Integration in Raven.
13+
14+
<Note>
15+
If you are sending SMSs in India, TRAI has mandated to register their
16+
business, headers (sender IDs), and templates on any of the DLT platforms.
17+
</Note>
18+
19+
### Step 2. ClickSend Integration in Raven
20+
21+
In the Provider form in Raven for ClickSend, you need to fill the following values
22+
23+
| Key | Details |
24+
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25+
| Api Key | If you are signed up in 2Factor.in, you can get your api key here You can have a quick access of the key as well on your ClickSend dashboard toolbar key icon |
26+
| Sender | You can setup your sender from [here](https://dashboard.clicksend.com/numbers/sms) Go to ClickSend Dashboard → Numbers → SMS. |
27+
28+
### Step 3. Delivery Reports
29+
30+
There is no additional configuration required to setup delivery reports. Raven manages the delivery callback internally for ClickSend.
31+
32+
## 🔗 Links
33+
34+
- [ClickSend Website](https://www.clicksend.com/in/)
35+
- [ClickSend SMS documentation](https://developers.clicksend.com/docs/)
36+
37+
<Info>
38+
If you are facing issues with this integration or find something missing,
39+
please write to us at support@ravenapp.dev
40+
</Info>

‎docs/sms/integrations/exotel.mdx

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,15 @@ then add Exotel Integration in Raven.
1717

1818
### Step 2. Exotel Integration in Raven
1919

20-
| Keys | Details |
21-
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22-
| `API Key` | API Key (username). Find your API credentials [here](https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-api-key-api-token-account-sid-and-subdomain-). |
23-
| `API Token` | API Token (password). Find your API credentials [here](https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-api-key-api-token-account-sid-and-subdomain-). |
24-
| `Sender` | On the Exotel dashboard, navigate to Account > Settings > SMS Sender IDs. Specify one of your ExoPhone or Sender ID (header) linked to it. ExoPhone: From = '080XXXXXX' Transactional Sender ID: From = 'EXOTEL' (If linked to your ExoPhone) Promotional Numeric Sender ID: From = '600XXX' (If linked to your ExoPhone) To view or configure your Sender IDs, refer . The Sender ID should be linked with the SMS template as registered on DLT portal. |
25-
| `Account SID` | Account SID. Find your API credentials [here](https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-api-key-api-token-account-sid-and-subdomain-). |
26-
| `Region` | Default is Singapore. If the Exotel Account URL is my.in.exotel.com then select India. More details [here](https://support.exotel.com/support/solutions/articles/126794-how-to-choose-an-sms-sender-id-). |
27-
| `Route` | Applicable only for SMSes sent by Indian businesses to Indian destination numbers. Use the route type specified when registering your templates. Possible values: Transactional, OTP, Promotional. |
28-
| `DLT Entity ID` | Applicable only for SMS sent by Indian businesses to Indian destination numbers. Your Entity Id as registered on DLT (Distributed Ledger Technology) portal of operators in India. This is mandatory to be passed in API or configured on Dashboard for SMSes towards Indian destination ([Learn more about DLT](https://support.exotel.com/support/solutions/articles/3000096504-trai-regulations-on-commercial-communications-dlt-portal-sms-in-india)). |
29-
30-
---
20+
| Keys | Details |
21+
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22+
| `API Key` | API Key (username). Find your API credentials [here](https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-api-key-api-token-account-sid-and-subdomain-). |
23+
| `API Token` | API Token (password). Find your API credentials [here](https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-api-key-api-token-account-sid-and-subdomain-). |
24+
| `Sender` | Once approved on the DLT platform, you can edit an existing SENDER ID or assign it while adding a new ExoPhone, on the Exotel dashboard. navigate to Account > Settings > SMS Sender IDs. Specify one of your ExoPhone or Sender ID (header) linked to it.<br /> For more details see here  [SMS Configuration Setting](https://my.exotel.com/Exotel/settings/site#senderid-settings) <br/>Use 6 Digit numeric sender for Promotional SMS or 6 alpha Characters for Transactional SMS. <br/> ExoPhone: From = ‘080XXXXXX’ <br/> Transactional Sender ID: From = ‘EXOTEL’ (If linked to your ExoPhone) <br/> Promotional Numeric Sender ID: From = ‘600XXX’ (If linked to your ExoPhone) |
25+
| `Account SID` | Account SID. Find your API credentials [here](https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-api-key-api-token-account-sid-and-subdomain-). |
26+
| `Region` | Default is Singapore. If the Exotel Account URL is my.in.exotel.com then select India. More details [here](https://support.exotel.com/support/solutions/articles/126794-how-to-choose-an-sms-sender-id-). |
27+
| `Route` | Applicable only for SMSes sent by Indian businesses to Indian destination numbers. Use the route type specified when registering your templates. Possible values: Transactional, OTP, Promotional. |
28+
| `DLT Entity ID` | Applicable only for SMS sent by Indian businesses to Indian destination numbers. Your Entity Id as registered on DLT (Distributed Ledger Technology) portal of operators in India. This is mandatory to be passed in API or configured on Dashboard for SMSes towards Indian destination ([Learn more about DLT](https://support.exotel.com/support/solutions/articles/3000096504-trai-regulations-on-commercial-communications-dlt-portal-sms-in-india)). |
3129

3230
### Step 3. Delivery Reports
3331

‎docs/sms/integrations/route mobile.mdx renamed to ‎docs/sms/integrations/route_mobile.mdx

File renamed without changes.

0 commit comments

Comments
 (0)