Skip to content

Commit eff4555

Browse files
ShamkhShamkh
committed
template aliagnment
1 parent 2f02f8a commit eff4555

File tree

5 files changed

+193
-71
lines changed

5 files changed

+193
-71
lines changed

‎articles/communication-services/quickstarts/advanced-messaging/whatsapp/includes/templates/messages-quickstart-template-messages-java.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,54 @@ ms.custom: include file
1111
ms.author: armohamed
1212
---
1313

14+
## Prerequisites
15+
16+
- [Register WhatsApp Business Account with your Azure Communication Services resource](./connect-whatsapp-business-account.md).
17+
- [Create WhatsApp template message](#create-and-manage-whatsapp-template-message).
18+
- Active WhatsApp phone number to receive messages.
19+
20+
## Object model
21+
22+
The following classes and interfaces handle some of the major features of the Azure Communication Services Messages SDK for Java.
23+
24+
| Class Name | Description |
25+
| --- | --- |
26+
| `NotificationMessagesClient` | Connects to your Azure Communication Services resource. It sends the messages. |
27+
| `MessageTemplate` | Defines which template you use and the content of the template properties for your message. |
28+
| `TemplateNotificationContent` | Defines the "who" and the "what" of the template message you intend to send. |
29+
30+
> [!NOTE]
31+
> For more information, see the Azure SDK for Java reference at [com.azure.communication.messages Package](/java/api/com.azure.communication.messages).
32+
33+
### Supported WhatsApp template types
34+
35+
| Template type | Description |
36+
| --- | --- |
37+
| Text-based message templates | WhatsApp message templates are specific message formats with or without parameters. |
38+
| Media-based message templates | WhatsApp message templates with media parameters for header components. |
39+
| Interactive message templates | Interactive message templates expand the content you can send recipients, by including interactive buttons using the components object. Both Call-to-Action and Quick Reply are supported. |
40+
| Location-based message templates | WhatsApp message templates with location parameters in terms Longitude and Latitude for header components.|
41+
42+
## Common configuration
43+
44+
Follow these steps to add the necessary code snippets to the `messages-quickstart.py` python program.
45+
- [Create and manage WhatsApp template message](#create-and-manage-whatsapp-template-message).
46+
- [Authenticate the client](#authenticate-the-client).
47+
- [Set channel registration ID](#set-channel-registration-id).
48+
- [Set recipient list](#set-recipient-list).
49+
50+
### Create and manage WhatsApp template message
51+
52+
WhatsApp message templates are specific message formats that businesses use to send out notifications or customer care messages to people that opted in to notifications. Messages can include appointment reminders, shipping information, issue resolution, or payment updates. **Before start using Advanced messaging SDK to send templated messages, user needs to create required templates in the WhatsApp Business Platform**.
53+
54+
For more information about WhatsApp requirements for templates, see the WhatsApp Business Platform API references:
55+
- [Create and Manage Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/).
56+
- [View Template Components](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components).
57+
- [Send Template Messages](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates).
58+
- Businesses must also adhere to [opt-in requirements](https://developers.facebook.com/docs/whatsapp/overview/getting-opt-in) before sending messages to WhatsApp users.
59+
60+
[!INCLUDE [Common setting for using Advanced Messages SDK](./includes/common-setting-java.md)]
61+
1462
## Set up environment
1563
To set up an environment for sending messages, complete the steps in the following sections.
1664

@@ -25,18 +73,12 @@ To set up an environment for sending messages, complete the steps in the followi
2573
## Code examples
2674

2775
Follow these steps to add required code snippets to the main function of your `App.java` file.
28-
- [Start sending messages between a business and a WhatsApp user](#start-sending-messages-between-a-business-and-a-whatsapp-user).
29-
- [Authenticate the client](#authenticate-the-client).
30-
- [Set channel registration ID](#set-channel-registration-id).
31-
- [Set recipient list](#set-recipient-list).
3276
- [List WhatsApp templates in the Azure portal](#list-whatsapp-templates-in-the-azure-portal).
3377
- [Send template message with text parameters in the body](#send-template-message-with-text-parameters-in-the-body).
3478
- [Send template message with media parameter in the header](#send-template-message-with-media-parameter-in-the-header).
3579
- [Send template message with quick reply buttons](#send-template-message-with-quick-reply-buttons).
3680
- [Send Template message with call to action buttons and dynamic link](#send-template-message-with-call-to-action-buttons-and-dynamic-link).
3781

38-
[!INCLUDE [Common setting for using Advanced Messages SDK](../common-setting-java.md)]
39-
4082
### List WhatsApp templates in the Azure portal
4183

4284
To view your templates in the Azure portal, go to your Azure Communication Services resource > **Advanced Messaging** > **Templates**.

‎articles/communication-services/quickstarts/advanced-messaging/whatsapp/includes/templates/messages-quickstart-template-messages-javascript.md

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,68 @@ ms.custom: include file
1111
ms.author: shamkh
1212
---
1313

14-
## Setting up
15-
To set up an environment for sending messages, complete the steps in the following sections.
14+
## Prerequisites
1615

17-
### Prerequisite
18-
- [WhatsApp Business Account registered with your Azure Communication Services resource](../../connect-whatsapp-business-account.md).
16+
- [Register WhatsApp Business Account with your Azure Communication Services resource](./connect-whatsapp-business-account.md).
17+
- [Create WhatsApp template message](#create-and-manage-whatsapp-template-message).
1918
- Active WhatsApp phone number to receive messages.
2019
- [Node.js](https://nodejs.org/) Active LTS and Maintenance LTS versions (We recommend 8.11.1 and 10.14.1).
2120
- [Node.js](https://nodejs.org/) Active LTS and Maintenance LTS versions (8.11.1 and 10.14.1 are recommended)
22-
- In a terminal or command window, run `node --version` to check that Node.js is installed
21+
- In a terminal or command window, run `node --version` to check that Node.js is installed
2322

24-
[!INCLUDE [Setting up for JavaScript Application](../javascript-application-setup.md)]
23+
## Object model
2524

26-
## Code examples
25+
The following classes and interfaces handle some of the major features of the Azure Communication Services Messages SDK for Java.
2726

28-
Follow these steps to add required code snippets to the main function of your `send-messages.js` file.
29-
- [Start sending messages between a business and a WhatsApp user](#start-sending-messages-between-a-business-and-a-whatsapp-user).
27+
| Class Name | Description |
28+
| --- | --- |
29+
| `NotificationMessagesClient` | Connects to your Azure Communication Services resource. It sends the messages. |
30+
| `MessageTemplate` | Defines which template you use and the content of the template properties for your message. |
31+
| `TemplateNotificationContent` | Defines the "who" and the "what" of the template message you intend to send. |
32+
33+
> [!NOTE]
34+
> For more information, see the Azure SDK for JavaScript reference [@azure-rest/communication-messages package](/javascript/api/@azure-rest/communication-messages)
35+
36+
### Supported WhatsApp template types
37+
38+
| Template type | Description |
39+
| --- | --- |
40+
| Text-based message templates | WhatsApp message templates are specific message formats with or without parameters. |
41+
| Media-based message templates | WhatsApp message templates with media parameters for header components. |
42+
| Interactive message templates | Interactive message templates expand the content you can send recipients, by including interactive buttons using the components object. Both Call-to-Action and Quick Reply are supported. |
43+
| Location-based message templates | WhatsApp message templates with location parameters in terms Longitude and Latitude for header components.|
44+
45+
## Common configuration
46+
47+
Follow these steps to add the necessary code snippets to the `messages-quickstart.py` python program.
48+
- [Create and manage WhatsApp template message](#create-and-manage-whatsapp-template-message).
3049
- [Authenticate the client](#authenticate-the-client).
3150
- [Set channel registration ID](#set-channel-registration-id).
3251
- [Set recipient list](#set-recipient-list).
52+
53+
### Create and manage WhatsApp template message
54+
55+
WhatsApp message templates are specific message formats that businesses use to send out notifications or customer care messages to people that opted in to notifications. Messages can include appointment reminders, shipping information, issue resolution, or payment updates. **Before start using Advanced messaging SDK to send templated messages, user needs to create required templates in the WhatsApp Business Platform**.
56+
57+
For more information about WhatsApp requirements for templates, see the WhatsApp Business Platform API references:
58+
- [Create and Manage Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/).
59+
- [View Template Components](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components).
60+
- [Send Template Messages](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates).
61+
- Businesses must also adhere to [opt-in requirements](https://developers.facebook.com/docs/whatsapp/overview/getting-opt-in) before sending messages to WhatsApp users.
62+
63+
[!INCLUDE [Common setting for using Advanced Messages SDK](./includes/common-setting-javascript.md)]
64+
65+
## Setting up
66+
To set up an environment for sending messages, complete the steps in the following sections.
67+
68+
[!INCLUDE [Setting up for JavaScript Application](../javascript-application-setup.md)]
69+
70+
## Code examples
71+
72+
Follow these steps to add required code snippets to the main function of your `send-messages.js` file.
3373
- [List WhatsApp templates in the Azure portal](#list-whatsapp-templates-in-the-azure-portal).
3474
- [Send template message with text parameters in the body](#send-template-message-with-text-parameters-in-the-body).
3575

36-
[!INCLUDE [Common setting for using Advanced Messages SDK](../common-setting-javascript.md)]
37-
3876
### List WhatsApp templates in the Azure portal
3977

4078
To view your templates in the Azure portal, go to your Azure Communication Services resource > **Advanced Messaging** > **Templates**.

‎articles/communication-services/quickstarts/advanced-messaging/whatsapp/includes/templates/messages-quickstart-template-messages-python.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,54 @@ ms.custom: include file
1111
ms.author: shamkh
1212
---
1313

14+
## Prerequisites
15+
16+
- [Register WhatsApp Business Account with your Azure Communication Services resource](./connect-whatsapp-business-account.md).
17+
- [Create WhatsApp template message](#create-and-manage-whatsapp-template-message).
18+
- Active WhatsApp phone number to receive messages.
19+
20+
## Object model
21+
22+
The following classes and interfaces handle some of the major features of the Azure Communication Services Messages SDK for Python.
23+
24+
| Class Name | Description |
25+
| --- | --- |
26+
| `NotificationMessagesClient` | Connects to your Azure Communication Services resource. It sends the messages. |
27+
| `MessageTemplate` | Defines which template you use and the content of the template properties for your message. |
28+
| `TemplateNotificationContent` | Defines the "who" and the "what" of the template message you intend to send. |
29+
30+
> [!NOTE]
31+
> For more information, seer the Azure SDK for Python reference [messages Package](/python/api/azure-communication-messages/azure.communication.messages).
32+
33+
### Supported WhatsApp template types
34+
35+
| Template type | Description |
36+
| --- | --- |
37+
| Text-based message templates | WhatsApp message templates are specific message formats with or without parameters. |
38+
| Media-based message templates | WhatsApp message templates with media parameters for header components. |
39+
| Interactive message templates | Interactive message templates expand the content you can send recipients, by including interactive buttons using the components object. Both Call-to-Action and Quick Reply are supported. |
40+
| Location-based message templates | WhatsApp message templates with location parameters in terms Longitude and Latitude for header components.|
41+
42+
## Common configuration
43+
44+
Follow these steps to add the necessary code snippets to the `messages-quickstart.py` python program.
45+
- [Create and manage WhatsApp template message](#create-and-manage-whatsapp-template-message).
46+
- [Authenticate the client](#authenticate-the-client).
47+
- [Set channel registration ID](#set-channel-registration-id).
48+
- [Set recipient list](#set-recipient-list).
49+
50+
### Create and manage WhatsApp template message
51+
52+
WhatsApp message templates are specific message formats that businesses use to send out notifications or customer care messages to people that opted in to notifications. Messages can include appointment reminders, shipping information, issue resolution, or payment updates. **Before start using Advanced messaging SDK to send templated messages, user needs to create required templates in the WhatsApp Business Platform**.
53+
54+
For more information about WhatsApp requirements for templates, see the WhatsApp Business Platform API references:
55+
- [Create and Manage Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/).
56+
- [View Template Components](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components).
57+
- [Send Template Messages](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates).
58+
- Businesses must also adhere to [opt-in requirements](https://developers.facebook.com/docs/whatsapp/overview/getting-opt-in) before sending messages to WhatsApp users.
59+
60+
[!INCLUDE [Common setting for using Advanced Messages SDK](./includes/common-setting-python.md)]
61+
1462
## Set up environment
1563

1664
[!INCLUDE [Setting up for Python Application](../python-application-setup.md)]

‎articles/communication-services/quickstarts/advanced-messaging/whatsapp/includes/templates/template-messages-quick-reference-net.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,54 @@ ms.custom: include file
1111
ms.author: memontic
1212
---
1313

14+
## Prerequisites
15+
16+
- [Register WhatsApp Business Account with your Azure Communication Services resource](./connect-whatsapp-business-account.md).
17+
- [Create WhatsApp template message](#create-and-manage-whatsapp-template-message).
18+
- Active WhatsApp phone number to receive messages.
19+
20+
## Object model
21+
22+
The following classes and interfaces handle some of the major features of the Azure Communication Services Messages SDK for Python.
23+
24+
| Class Name | Description |
25+
| --- | --- |
26+
| `NotificationMessagesClient` | Connects to your Azure Communication Services resource. It sends the messages. |
27+
| `MessageTemplate` | Defines which template you use and the content of the template properties for your message. |
28+
| `TemplateNotificationContent` | Defines the "who" and the "what" of the template message you intend to send. |
29+
30+
> [!NOTE]
31+
> For more information, see the Azure SDK for .NET reference [Azure.Communication.Messages Namespace](/dotnet/api/azure.communication.messages).
32+
33+
### Supported WhatsApp template types
34+
35+
| Template type | Description |
36+
| --- | --- |
37+
| Text-based message templates | WhatsApp message templates are specific message formats with or without parameters. |
38+
| Media-based message templates | WhatsApp message templates with media parameters for header components. |
39+
| Interactive message templates | Interactive message templates expand the content you can send recipients, by including interactive buttons using the components object. Both Call-to-Action and Quick Reply are supported. |
40+
| Location-based message templates | WhatsApp message templates with location parameters in terms Longitude and Latitude for header components.|
41+
42+
## Common configuration
43+
44+
Follow these steps to add the necessary code snippets to the `messages-quickstart.py` python program.
45+
- [Create and manage WhatsApp template message](#create-and-manage-whatsapp-template-message).
46+
- [Authenticate the client](#authenticate-the-client).
47+
- [Set channel registration ID](#set-channel-registration-id).
48+
- [Set recipient list](#set-recipient-list).
49+
50+
### Create and manage WhatsApp template message
51+
52+
WhatsApp message templates are specific message formats that businesses use to send out notifications or customer care messages to people that opted in to notifications. Messages can include appointment reminders, shipping information, issue resolution, or payment updates. **Before start using Advanced messaging SDK to send templated messages, user needs to create required templates in the WhatsApp Business Platform**.
53+
54+
For more information about WhatsApp requirements for templates, see the WhatsApp Business Platform API references:
55+
- [Create and Manage Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/).
56+
- [View Template Components](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components).
57+
- [Send Template Messages](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates).
58+
- Businesses must also adhere to [opt-in requirements](https://developers.facebook.com/docs/whatsapp/overview/getting-opt-in) before sending messages to WhatsApp users.
59+
60+
[!INCLUDE [Common setting for using Advanced Messages SDK](./includes/common-setting-net.md)]
61+
1462
## Set up environment
1563

1664
[!INCLUDE [Setting up for .NET Application](../dot-net-application-setup.md)]

0 commit comments

Comments
 (0)