• Prerequisites
  
• Requests
  

• Phone number format
  
• Send URLs in text messages
  
• Apply formatting in text messages
  

• Responses
  
• Example
  
• Cut-off control
  

Prerequisites

• Woztell account activated.
  
• To use the Woztell API, you must first authenticate yourself and receive a token that enables you to access the service.
  Contact support@woztell.com for more information on how to do this.
  
• The message must meet the cut-off control service requirements.
  

Requests

Message API calls are sent to the /messages endpoint regardless of message type, but the content of the JSON message body differs for each type of message (text or templates). See the following documentation for information regarding the type of messages you want to send:

POST: https://webservice.woztell.com/webhook/messages

Parameters:

Parameter name	Data type	Description	Possible values
WOZTELL_ADMIN*	String	Email address for your Woztell account.	admin@company.com
WOZTELL_TOKEN*	String	Your Woztell account token.	abc-defgh-ijk-123
WOZTELL_NUMBER	String	Woztell phone number validated by WhatsApp. If you don't send a number, the main WhatsApp number will be used	"+1-631-555-1002", "16315551002", "001(631)555-1002"or "1 631 555 1002"
DATA	JSON	See the following documentation in the Data Parameters section.

*Parameter is required

• Text message
  

POST https://webservice.woztell.com/webhook/messages
{
 "WOZTELL_ADMIN":"your-woztell-admin-email",
 "WOZTELL_TOKEN":"your-woztell-token",
 "DATA":
 {
 "TO":"whatsapp-number",
 "MESSAGE":"your-message-text",
 "USER":"issuer-name"
 } }

DATA parameters:

*Parameter is required

• Template message
  

You can use the messages endpoint to send message templates to your customers. You can use /w -list in WhatsApp channel to show your verified templates. If you have no verified templates or you need more, follow the instruction in this article to create templates.

POST https://webservice.woztell.com/webhook/messages
{
 "WOZTELL_ADMIN":"your-woztell-admin-email",
 "WOZTELL_TOKEN":"your-woztell-token",
 "DATA":
  {
   "TO":"whatsapp-number",
   "TEMPLATE":"your-template-code",
 "PARAMETER 1":"your-parameter-1-value",
 ...
 "PARAMETER 10":"your-parameter-10-value"
   "USER":"issuer-name"
  } }

DATA parameters:

*Parameter is required.

Phone number formats

The phone number in the request can be in any WhatsApp format.

The recommended best practice is to specify the country code with the phone number always and explicitly prefix it with a plus sign (+).

Send URLs in text messages

By default, the WhatsApp mobile application recognizes URLs and makes them interactive. To include a preview of the URL, make sure the URL starts with http:// or https://. A hostname is also required since the IP addresses do not match.

Most of the time, when you send a URL, with or without a preview, the recipient of the message will see a URL that you can click on.

Apply formatting in text messages

WhatsApp allows you to apply some formatting options to messages. To format a message, or part of it, use the following formatting symbols:

Response

See the following document for more information about the following types of error and status messages:

{
 "STATUS":"ERROR",
 "DESCRIPTION":"INVALID JSON DATA" }

{
 "STATUS":"SUCCESS",
 "IDMESSAGE":"whatsapp-message-id",
 "DESCRIPTION":"" }

Example

When a message is sent in a request, the customer will receive a message such as this:

POST https://webservice.woztell.com/webhook/messages
{
 "WOZTELL_ADMIN":"admin@woztell.com",
 "WOZTELL_TOKEN":"123-45678-90abcdefg-hij-klmn",
 "DATA":
  {
   "TO":"00123456789",
   "MESSAGE":"Hello World!",
   "USER":"John Woztell"
  } }

You can use this PHP to send WhatsApp messages using your Woztell account:

<?php
$curl = curl_init();
 
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://webservice.woztell.com/webhook/messages',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => 
 array(
  'WOZTELL_ADMIN' => 'admin@woztell.com',
  'WOZTELL_TOKEN' => '123-45678-90abcdefg-hij-klmn',
  'DATA' => '{
    "TO":"00123456789",
    "MESSAGE":"Hello world!",
    "USER":"John Woztell"
    }'
  ),
));
 
$response = curl_exec($curl);
 
curl_close($curl); echo $response;

Cut-off Control

Cut-off control prevents messages from being delivered to users out of certain conditions. Here's a summary of the requirements:

• Regular text messages (i.e., any non-template Messages) can only be delivered on the 24 hours after the last time the customer sent a message to your business.
  
• Template Messages do not have this restriction and should be the preferred way of reaching a customer.
  
• The business account should be eligible for payments.