Spendo API Docs
  • Introduction!
  • Quick Start
  • HTTP
    • SMS
      • Send SMS Local
      • Send SMS International
      • Send SMS OTP
      • Send SMS Bulk
      • AI Messaging
        • Send SMS AI
        • Send SMS Bulk AI
    • Verification
      • BVN Number OTP
      • NIN Number OTP
      • Phone Number Verification
        • Verify Phone Number OTP
    • Whatsapp
      • Whatsapp Message
      • Whatsapp Message Template
      • Whatsapp OTP
    • Voice OTP
      • Voice OTP
  • SMPP
    • SMPP Specification
    • SMPP Servers
    • SMPP Authentication
    • SMPP Configuration
    • SMPP Message PDU
    • SMPP Client Configuration
    • SMPP Sample Code
  • Libraries And SDK's
    • Node.JS SDK
Powered by GitBook
On this page

Was this helpful?

  1. HTTP
  2. Whatsapp

Whatsapp Message Template

This API allows you to send a pre-approved WhatsApp message template to a specified recipient.

Send Whatsapp Template

POST https://api.getspendo.com/gateway/api/v1/send/whatsapp

Headers

Name
Type
Description

apiKey*

String

The API key that you get from spendo's dashboard.

Request Body

Name
Type
Description

message*

string

The text message that you want to send, formatted as a string.

phoneNumber*

string

The phone number of the recipient, formatted as a string without any spaces or special characters.

templateName*

string

The Name of the pre-approved message template that you want to use, represented as a string.

templateParams*

Array

An arrayList containing the dynamic parameters that you want to replace in the message template.

{
  "success": true,
  "message": "Message sent",
  "code": 0,
  "data": null
}

{
  "success": false,
  "message": "Error sending message",
  "code": 0,
  "data": null
}
{
    // Response
}

Good to know: You can use our API Method block to fully test all the API method.

Take a look at how you might call this method using our official libraries, or via curl:

curl --location --request POST 'https://api.getspendo.com/gateway/api/v1/send/whatsapp/template' \
--header 'apiKey: test_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
  "message": "string",
  "phoneNumber": "string",
  "templateName": "string",
    "templateParams": [
      {
        "text": "3232323",
        "type": "text"
      }
  ]
}'
var axios = require('axios');
var data = JSON.stringify({
  "message": "string",
  "phoneNumber": "string",
  "templateName": "string",
  "templateParams": [
      {
        "text": "3232323",
        "type": "text"
      }
  ]
});

var config = {
  method: 'post',
  url: 'https://api.getspendo.com/gateway/api/v1/send/whatsapp/template',
  headers: { 
    'apiKey': 'test_api_key', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
import http.client
import json

conn = http.client.HTTPSConnection("api.getspendo.com")
payload = json.dumps({
  "message": "string",
  "phoneNumber": "string",
  "templateName": "string",
    "templateParams": [
      {
        "text": "3232323",
        "type": "text"
      }
  ]
})
headers = {
  'apiKey': 'test_api_key',
  'Content-Type': 'application/json'
}
conn.request("POST", "/gateway/api/v1/send/whatsapp/template", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.getspendo.com/gateway/api/v1/send/whatsapp/template',
  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 =>'{
  "message": "string",
  "phoneNumber": "string",
  "phoneNumber": "string",
  "templateName": "string",
    "templateParams": [
      {
        "text": "3232323",
        "type": "text"
      }
  ]
}',
  CURLOPT_HTTPHEADER => array(
    'apiKey: test_api_key',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"phoneNumber\": \"2347037716490\",\n  \"templateName\": \"otp_code\",\n  \"templateParams\": [\n    {\n      \"text\": \"3232323\",\n      \"type\": \"text\"\n    }\n  ]\n}");
Request request = new Request.Builder()
  .url("https://api.getspendo.com/gateway/api/v1/send/whatsapp/template")
  .method("POST", body)
  .addHeader("apiKey", "test_api_key")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "https://api.getspendo.com/gateway/api/v1/send/whatsapp/template",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "apiKey": "test_api_key",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "message": "string",
    "phoneNumber": "string",
    "phoneNumber": "string",
    "templateName": "string",
      "templateParams": [
        {
          "text": "3232323",
          "type": "text"
        }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
PreviousWhatsapp MessageNextWhatsapp OTP

Last updated 2 years ago

Was this helpful?