Send Address Message · WhatsApp · 1SPOC API Reference

infoOverview

About this API

This API is used to send the address message to the end user.

MethodPOST

Versionv3.0

Base URLhttps://partnersv1.pinbot.ai/v3

Content Typeapplication/json

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader

Field nameapikey

Example valueYOUR_WABA_API_KEY

routeParameters

Path Parameters

Substitute these placeholders in the endpoint URL before sending the request.

phone_number_idstringRequiredResource identifier for phone number id.

uploadInput

Request Body

Send a application/json payload. Replace placeholder values with data from your integration.

{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "91XXXXXXXXXX",
"type": "interactive",
"interactive": {
"type": "address_message",
"body": {
"text": "Thanks for your order! Tell us what address you'd like this order
delivered to."
},
"action": {
"name": "address_message",
"parameters": {
"country" :"COUNTRY_ISO_CODE"
}

}
}
}

{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}

smartphoneEmbedded Signup Sandbox

Test with simulated WABA credentials

Use the sample WABA ID and WABA number produced by the Embedded Signup simulation. Sending here never calls the real WhatsApp API.

9:41⌁

chevron_left

1SPOC Demobusiness account

videocamcall

lockMessages are end-to-end encrypted. This preview is simulated.

Today

Ready to preview: Send Address Message.9:41

add_circle

Messagedescription

photo_cameramic

codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

Request URL

shield_lockCredentials protectedAdd secrets only in your secure server environment.

downloadSDK

curl --request POST 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages' \
  --header 'apikey: <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"91XXXXXXXXXX\",\n\"type\": \"interactive\",\n\"interactive\": {\n\"type\": \"address_message\",\n\"body\": {\n\"text\": \"Thanks for your order! Tell us what address you'\''d like this order\ndelivered to.\"\n},\n\"action\": {\n\"name\": \"address_message\",\n\"parameters\": {\n\"country\" :\"COUNTRY_ISO_CODE\"\n}\n\n}\n}\n}"
}'

const response = await fetch('https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages', {
  method: 'POST',
  headers: {
    "apikey": "<API_KEY>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"91XXXXXXXXXX\",\n\"type\": \"interactive\",\n\"interactive\": {\n\"type\": \"address_message\",\n\"body\": {\n\"text\": \"Thanks for your order! Tell us what address you'd like this order\ndelivered to.\"\n},\n\"action\": {\n\"name\": \"address_message\",\n\"parameters\": {\n\"country\" :\"COUNTRY_ISO_CODE\"\n}\n\n}\n}\n}"
  })
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

const response = await fetch('https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages', {
  method: 'POST',
  headers: {
    "apikey": "<API_KEY>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"91XXXXXXXXXX\",\n\"type\": \"interactive\",\n\"interactive\": {\n\"type\": \"address_message\",\n\"body\": {\n\"text\": \"Thanks for your order! Tell us what address you'd like this order\ndelivered to.\"\n},\n\"action\": {\n\"name\": \"address_message\",\n\"parameters\": {\n\"country\" :\"COUNTRY_ISO_CODE\"\n}\n\n}\n}\n}"
  })
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

import json
import requests

url = 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages'
headers = {
  "apikey": "<API_KEY>",
  "Content-Type": "application/json"
}
payload = json.loads(r'''{
  "raw_example": "{\\n\\"messaging_product\\": \\"whatsapp\\",\\n\\"recipient_type\\": \\"individual\\",\\n\\"to\\": \\"91XXXXXXXXXX\\",\\n\\"type\\": \\"interactive\\",\\n\\"interactive\\": {\\n\\"type\\": \\"address_message\\",\\n\\"body\\": {\\n\\"text\\": \\"Thanks for your order! Tell us what address you\'d like this order\\ndelivered to.\\"\\n},\\n\\"action\\": {\\n\\"name\\": \\"address_message\\",\\n\\"parameters\\": {\\n\\"country\\" :\\"COUNTRY_ISO_CODE\\"\\n}\\n\\n}\\n}\\n}"
}''')
response = requests.post(url, headers=headers, json=payload)

response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
String body = """
{
  "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"91XXXXXXXXXX\",\n\"type\": \"interactive\",\n\"interactive\": {\n\"type\": \"address_message\",\n\"body\": {\n\"text\": \"Thanks for your order! Tell us what address you'd like this order\ndelivered to.\"\n},\n\"action\": {\n\"name\": \"address_message\",\n\"parameters\": {\n\"country\" :\"COUNTRY_ISO_CODE\"\n}\n\n}\n}\n}"
}
""";
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages"))
    .header("apikey", "<API_KEY>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());

<?php
$curl = curl_init();
$payload = '{
  "raw_example": "{\\n\\"messaging_product\\": \\"whatsapp\\",\\n\\"recipient_type\\": \\"individual\\",\\n\\"to\\": \\"91XXXXXXXXXX\\",\\n\\"type\\": \\"interactive\\",\\n\\"interactive\\": {\\n\\"type\\": \\"address_message\\",\\n\\"body\\": {\\n\\"text\\": \\"Thanks for your order! Tell us what address you\'d like this order\\ndelivered to.\\"\\n},\\n\\"action\\": {\\n\\"name\\": \\"address_message\\",\\n\\"parameters\\": {\\n\\"country\\" :\\"COUNTRY_ISO_CODE\\"\\n}\\n\\n}\\n}\\n}"
}';
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ["apikey: <API_KEY>","Content-Type: application/json"],
    CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("apikey", "<API_KEY>");
var json = """
{
  "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"91XXXXXXXXXX\",\n\"type\": \"interactive\",\n\"interactive\": {\n\"type\": \"address_message\",\n\"body\": {\n\"text\": \"Thanks for your order! Tell us what address you'd like this order\ndelivered to.\"\n},\n\"action\": {\n\"name\": \"address_message\",\n\"parameters\": {\n\"country\" :\"COUNTRY_ISO_CODE\"\n}\n\n}\n}\n}"
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
)

func main() {
    request, err := http.NewRequest("POST", "https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages", bytes.NewBufferString("{\n  \"raw_example\": \"{\\n\\\"messaging_product\\\": \\\"whatsapp\\\",\\n\\\"recipient_type\\\": \\\"individual\\\",\\n\\\"to\\\": \\\"91XXXXXXXXXX\\\",\\n\\\"type\\\": \\\"interactive\\\",\\n\\\"interactive\\\": {\\n\\\"type\\\": \\\"address_message\\\",\\n\\\"body\\\": {\\n\\\"text\\\": \\\"Thanks for your order! Tell us what address you'd like this order\\ndelivered to.\\\"\\n},\\n\\\"action\\\": {\\n\\\"name\\\": \\\"address_message\\\",\\n\\\"parameters\\\": {\\n\\\"country\\\" :\\\"COUNTRY_ISO_CODE\\\"\\n}\\n\\n}\\n}\\n}\"\n}"))
    if err != nil { panic(err) }
    request.Header.Set("Content-Type", "application/json")
    request.Header.Set("Accept", "application/json")
    request.Header.Set("apikey", "<API_KEY>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}

downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{
"messaging_product": "whatsapp",
"contacts": [
{
"input": "9175XXXXXXXX",
"wa_id": "9175XXXXXXXX"
}
],
"messages": [
{
"id":
"wamid.HBgMOTE3OTcyODkyNzEyFQIAERgSQUM3MzRCRjdFREYzOENDNTgwAA=
="
}
]
}
Currently address messages are supported in the following two countries: India and
Singapore. Below table outlines which fields are supported in which country specifically.

Field name Display label Input type Supported Limitations
countries
name Name text India, None
Singapore
phone_number Phone Number tel India, Valid phone
Singapore numbers only
in_pin_code Pin Code text India Max length: 6
sg_post_code Post Code number Singapore Max length: 6
house_number Flat/House text India None
Number
floor_number Floor Number text India None
tower_number Tower Number text India None
building_name Building/Apart text India None
ment Name
address Address text India, None
Singapore
landmark_area Landmark/Area text India None
unit_number Unit number text Singapore None
city City text India, None
Singapore
state State text India None

SENDING CUSTOM PARAMETERS WHILE SENDING MESSAGES
Sample Request:
{
"messaging_product": "whatsapp",
"preview_url": false,
"recipient_type": "individual",
"to": "{{Recipient-Phone-Number}}",
"type": "text",
"text": {
"body": "Sample-text"
},
"biz_opaque_callback_data": {
"source": "api",
"date": "2024-03-01",
"uuid": "fuif-0deu-dgyu-5674-jcur-jdu9-89eu"
}
}
Parameter Description:
Name Value
biz_opaque_callback_data Optional
An arbitrary string, useful for tracking.
For example, you could pass the message
template ID in this field to track your customer's
journey starting from the first message you send.

You could then track the ROI of different message
template types to determine the most effective one.
Any app subscribed to the messages webhook field
on the WhatsApp Business Account can get this
string, as it is included in statuses object within
webhook payloads.
Cloud API does not process this field, it just returns
it as part of sent/delivered/read message
webhooks.
Maximum 512 characters.
This custom parameter - biz_opaque_callback_data will be returned in the webhook
callback payload from Meta.
{"object":"whatsapp_business_account","entry":[{"id":"112365665238904","changes":[{"v
alue":{"messaging_product":"whatsapp","metadata":{"display_phone_number":"91XXXX
XXXXXX","phone_number_id":"10XXXXXXXXXXXXXX"},"statuses":[{"id":"wamid.HBgM
OTE3NTA3MDY2MzMxFQIAERgSQzZGNUVFOTgxMUUyMkI3MzVBAA==","status":"d
elivered","timestamp":"1709295133","recipient_id":"91XXXXXXXXXX","biz_opaque_call
back_data":"{\"source\":\"api\",\"date\":\"2024-03-01\", \"uuid\":
\"fuif-0deu-dgyu-5674-jcur-jdu9-89eu\"}","conversation":{"id":"a34a10abd87c7badad4d1f
c5bafadd71","origin":{"type":"marketing"}},"pricing":{"billable":true,"pricing_model":"CBP"
,"category":"marketing"}}]},"field":"messages"}]}]}

{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}

ruleHTTP Responses

Status Codes

200The request was successful.

400Bad request or invalid parameters.

401API key is missing or invalid.

403The request is not authorized for this resource.

404The requested resource was not found.

500The server encountered an error.