WhatsApp Business API

Docs for send

Text

https://api.example.com/wab

{
  "type": "text",
  "agent": "5215628341366",
  "number": "525510101234",
  "message": "test content"
}

Image

https://api.example.com/wab

{
  "type": "image",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg",
  "caption": "Sample image"
}

File

https://api.example.com/wab

{
  "type": "file",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf",
  "filename": "Sample file"
}

Audio

https://api.example.com/wab

{
  "type": "audio",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "https://www.buildquickbots.com/whatsapp/media/sample/audio/sample02.mp3"
}

Video

https://api.example.com/wab

{
  "type": "video",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "https://www.buildquickbots.com/whatsapp/media/sample/video/sample01.mp4"
}

Location

https://api.example.com/wab

{
  "type": "location",
  "agent": "5215628341366",
  "number": "525510101234",
  "longitude": 72.877655,
  "latitude": 19.075983,
  "name": "Mumbai",
  "address": "Mumbai, Maharashtra"
}

Sticker

https://api.example.com/wab

{
  "type": "sticker",
  "agent": "5215628341366",
  "number": "525510101234",
  "url": "http://www.buildquickbots.com/whatsapp/stickers/SampleSticker01.webp"
}

Contact

https://api.example.com/wab

{
  "type": "contacts",
  "agent": "5215628341366",
  "number": "525510101234",
  "contact": {
    "addresses": [
      {
        "city": "Menlo Park",
        "country": "United States",
        "country_code": "us",
        "state": "CA",
        "street": "1 Hacker Way",
        "type": "HOME",
        "zip": "94025"
      },
      {
        "city": "Menlo Park",
        "country": "United States",
        "country_code": "us",
        "state": "CA",
        "street": "200 Jefferson Dr",
        "type": "WORK",
        "zip": "94025"
      }
    ],
    "birthday": "1995-08-18",
    "emails": [
      {
        "email": "personal.mail@hackerzone.io",
        "type": "Personal"
      },
      {
        "email": "devsupport@hackerzone.io",
        "type": "Work"
      }
    ],
    "name": {
      "first_name": "John",
      "formatted_name": "John Wick",
      "last_name": "Wick"
    },
    "org": {
      "company": "Guspshup",
      "department": "Product",
      "title": "Manager"
    },
    "phones": [
      {
        "phone": "+1 (940) 555-1234",
        "type": "HOME"
      },
      {
        "phone": "+1 (650) 555-1234",
        "type": "WORK",
        "wa_id": "16505551234"
      }
    ],
    "urls": [
      {
        "url": "https://www.hackerzone.io",
        "type": "WORK"
      }
    ]
  }
}

---

Template Example

https://api.example.com/wab

{
  "type": "template",
  "agent": "5215589427963",
  "number": "525510101234",
  "templateName": "ejemplo_nota_1",
  "templateData": {
    "body": {
      "placeholders": ["2024-01-01", "John Dohe", "2024-01-02", "My awesome business", "12234", "2", "123852", "$ 1500", "12"]
    },
    "header": {
      "type": "DOCUMENT",
      "mediaUrl": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf",
      "filename": "document.pdf"
    }
  },
  "language": "es"
}

---

Inbound Response

{
  "type": "inbound",
  "payload": {
    "app": "5215589427963",
    "type": "message",
    "msisdn": "5215581XXXXXX",
    "added_on": "2023-12-04 22:19:24",
    "type_message": "image",
    "payload": {
      "id": "E8977F4F1E3060F18ADBFE0E6D2DF6C4",
      "source": "5215581XXXXXX",
      "type": "image",
      "sender": {
        "phone": "5215581XXXXXX",
        "name": "5215581XXXXXX",
        "country_code": 52,
        "dial_code": "5581989356"
      },
      "payload": {
        "caption": "",
        "url": "https://storage.onechat.mx/8141621060/2502100f-a62d-4e72-8137-ab1a22a1fa79.jpeg",
        "contentType": "image/jpeg",
        "urlExpiry": 1701857964
      }
    },
    "charge": 0.5
  }
}