Send Text Template

api docs

The sendTextTemplate function allows you to send a text message template to a WhatsApp number.

async function sendTextTemplate({
  to,
  templateName,
  language,
  parameters,
  config,
}: {
  to: string;
  templateName: string;
  language: string;
  parameters?:   parameters?: TemplateParameter[];
  config?: WsConfig;
}): Promise<SendMessageResponse>;

Parameters:

• to: The WhatsApp phone number recipient, including country code.
• templateName: The name of the pre-configured template to send.
• language: The language code for the template (e.g., en_US).
• parameters: Optional parameters to customize the template.
• config: Optional configuration settings.

Return

• Success: True for success, false for fail.
• Response: Information about the message sent, like the message ID, delivery status, and more.

Example usage

Send a text template

import { sendTextTemplate } from 'ws-cloud-api/templates'

sendTextTemplate({
  to: '573123456789',
  templateName: 'hello_world',
  language: 'en_US'
})
  .then((response) => {
    if (response.success) {
      console.log('Template message sent')
    }
  })
  .catch(console.error)

Send a text template with parameters

import { sendTextTemplate } from 'ws-cloud-api/templates'
import { ParametersTypes } from 'ws-cloud-api'

sendTextTemplate({
  to: '573123456789',
  templateName: 'login_code',
  language: 'en_US',
  parameters: [
    {
      type: ParametersTypes.Text,
      text: 'John Doe',
    },
    {
      type: ParametersTypes.Text,
      text: '123456',
    },
  ],
})
  .then((response) => {
    if (response.success) {
      console.log('Template message sent')
    }
  })
  .catch(console.error)