Skip links

WhatsApp Business API

Easily send messages through WhatsApp using our API. You can compose text to be sent out via WhatsApp and include messages with images, audio, and documents, all delivered promptly to the designated number.

How can I use this API?

To_utilise_this_API-removebg-preview

WhatsApp Content Type

Normal Text

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'msg="You have to check out this amazing messaging service https://www.whatsapp.com/"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'output="json"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="text"' \
--form 'previewUrl="false"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
TextMaximum character length for text is 4096 characters.
preview_urlValues should be true|false. If you set to true, preview of URL will be shown.

Normal Text -Preview

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'msg="You have to check out this amazing messaging service https://www.whatsapp.com/"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'output="json"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="text"' \
--form 'previewUrl="true"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
TextMaximum character length for text is 4096 characters.
preview_urlValues should be true|false. If you set to true, preview of URL will be shown.

Media- Audio

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'mediaUrl="https://file-examples-com.github.io/uploads/2017/11/file_example_MP3_700KB.mp3"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="media"' \
--form 'mediaType="audio"' \
--form 'output="json"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
Audio Extensions

audio/aacaudio/mp4audio/amraudio/mpeg,
audio/ogg; codecs=opus


Note: The base audio/ogg type is not supported.

Max Media SizePost-Processing Media Size after encryption should be 16 MB
captionCaption NOT allowed in Audio types messages.
link

Required when type is audio.

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.


Do not use this field when message type is set to text.

Media- Document With Caption

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'mediaUrl="https://smallpdf.com/handle-widget#url=https://assets.ctfassets.net/l3l0sjr15nav/29D2yYGKlHNm0fB2YM1uW4/8e638080a0603252b1a50f35ae8762fd/Get_Started_With_Smallpdf.pdf"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="media"' \
--form 'caption="Hello this is caption"' \
--form 'mediaType="document"' \
--form 'fileName="TestFile.pdf"' \
--form 'output="json"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
Document ExtensionsAny valid MIME-type.
Max Media SizePost-Processing Media Size after encryption should be 100 MB
filenameOptional Describes the filename for the specific document. Use only with document media.
captionMaximum characters length for caption is 1024 characters.
link

Required when type is document.

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.


Do not use this field when message type is set to text.

Media- Document

curl --location --request POST 'http://127.0.0.1:6010/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'mediaUrl="https://smallpdf.com/handle-widget#url=https://assets.ctfassets.net/l3l0sjr15nav/29D2yYGKlHNm0fB2YM1uW4/8e638080a0603252b1a50f35ae8762fd/Get_Started_With_Smallpdf.pdf"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="media"' \
--form 'mediaType="document"' \
--form 'fileName="TestFile.pdf"' \
--form 'output="json"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
Document ExtensionsAny valid MIME-type.
Max Media SizePost-Processing Media Size after encryption should be 100 MB
filenameOptional Describes the filename for the specific document. Use only with document media.
captionMaximum characters length for caption is 1024 characters.
link

Required when type is document.

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.


Do not use this field when message type is set to text.

Media- Image With Caption

curl --location --request POST 'http://127.0.0.1:6010/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'mediaUrl="https://asia.olympus-imaging.com/content/000107507.jpg"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="media"' \
--form 'caption="Hello this is caption"' \
--form 'mediaType="image"' \
--form 'output="json"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
Image Extensions

image/jpegimage/png

Max Media SizePost-Processing Media Size after encryption should be 5 MB
captionOptionalMaximum characters length for caption is 1024 characters.
link

Required when type is image.

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.


Do not use this field when message type is set to text.

Media- Image

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'mediaUrl="https://asia.olympus-imaging.com/content/000107507.jpg"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="media"' \
--form 'mediaType="image"' \
--form 'output="json"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
Image Extensions

image/jpegimage/png

Max Media SizePost-Processing Media Size after encryption should be 5 MB
link

Required when type is image.

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.


Do not use this field when message type is set to text.

Media- Video With Caption

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'mediaUrl="https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="media"' \
--form 'caption="Hello this is caption"' \
--form 'mediaType="video"' \
--form 'output="json"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
Video Extensions

video/mp4video/3gpp

Max Media SizePost-Processing Media Size after encryption should be 16 MB
captionMaximum characters length for caption is 1024 characters.
link

Required when type is video.

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.


Do not use this field when message type is set to text.

Media- Video

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'mediaUrl="https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="media"' \
--form 'mediaType="video"' \
--form 'output="json"' \
--form 'scheduleTime="2022-01-20 00:00:00"'
FieldDescription
Video Extensions

video/mp4video/3gpp

Max Media SizePost-Processing Media Size after encryption should be 16 MB
link

Required when type is video.

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.


Do not use this field when message type is set to text.

Location

curl --location --request POST 'http://127.0.0.1:6010/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="location"' \
--form 'output="json"' \
--form 'scheduleTime="2022-01-20 00:00:00"' \
--form 'msg="{
        \"longitude\": -122.425332,
        \"latitude\": 37.758056,
        \"name\": \"Facebook HQ\",
        \"address\": \"1 Hacker Way, Menlo Park, CA 94025\"
  }"'
FieldDescription
longitude

Required.

Longitude of the location.

latitude

Required.

Latitude of the location.

name

Optional.

Name of the location.

address

Optional.

Address of the location. Only displayed if name is present.

Sticker- (Link)

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'msg="{
		\"link\": \"https://img-05.stickers.cloud/packs/4536baa9-c14b-4d3e-964a-0cd4871eb11c/webp/431e0c1c-a10a-428d-a0bc-c7ad0741b940.webp\"
	}"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'output="json"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="sticker"'
FieldDescription
linkRequired when type is sticker. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.
msgTypemsgType needs to be sticker.

Interactive- Messages With Buttons

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'output="json"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="reply"' \
--form 'scheduleTime="2022-01-20 00:00:00"' \
--form 'msg="{
  \"header\": {
    \"type\": \"text\",
    \"text\": \"This the header\"
  },
  \"body\": {
    \"text\": \"This is body\"
  },
  \"footer\": {
    \"text\": \"This is footer\"
  },
  \"action\": {
    \"buttons\": [
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id1\",
          \"title\": \"Button1\"
        }
      },
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id2\",
          \"title\": \"Button2\"
        }
      },
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id3\",
          \"title\": \"Button3\"
        }
      }
    ]
  }
}"'
FieldDescription
header

Optional.

If you decide to include it, you must set the header’s type to text and add a text field with the desired content.

body

Required.

Your message’s body.

footer

Required.

Your message’s footer.

action

Required.

Inside action, you must nest:

  • button field with your button’s content, and
  • at least one section object (maximum of 10).

Inside section, you must add at least one rows object.

Interactive- Image With Buttons (Link)

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="reply"' \
--form 'scheduleTime="2022-01-20 00:00:00"' \
--form 'mediaType="image"' \
--form 'output="json"' \
--form 'msg="{
  \"header\": {
    \"type\": \"image\",
    \"image\": {
      \"link\": \"https://asia.olympus-imaging.com/content/000107507.jpg\"
    }
  },
  \"body\": {
    \"text\": \"This is body\"
  },
  \"footer\": {
    \"text\": \"This is footer\"
  },
  \"action\": {
    \"buttons\": [
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id1\",
          \"title\": \"Button1\"
        }
      },
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id2\",
          \"title\": \"Button2\"
        }
      },
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id3\",
          \"title\": \"Button3\"
        }
      }
    ]
  }
}"'
FieldDescription
header

Optional.

If you decide to include it, you must set the header’s type to text and add a text field with the desired content.

body

Required.

Your message’s body.

footer

Required.

Your message’s footer.

action

Required.

Inside action, you must nest:

  • button field with your button’s content, and
  • at least one section object (maximum of 10).

Inside section, you must add at least one rows object.

Interactive- Video With Buttons (Link)

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="reply"' \
--form 'scheduleTime="2022-01-20 00:00:00"' \
--form 'mediaType="video"' \
--form 'output="json"' \
--form 'msg="{
  \"header\": {
    \"type\": \"video\",
    \"video\": {
      \"link\": \"https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4\"
    }
  },
  \"body\": {
    \"text\": \"This is body\"
  },
  \"footer\": {
    \"text\": \"This is footer\"
  },
  \"action\": {
    \"buttons\": [
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id1\",
          \"title\": \"Button1\"
        }
      },
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id2\",
          \"title\": \"Button2\"
        }
      },
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id3\",
          \"title\": \"Button3\"
        }
      }
    ]
  }
}"'
FieldDescription
header

Optional.

If you decide to include it, you must set the header’s type to text and add a text field with the desired content.

body

Required.

Your message’s body.

footer

Required.

Your message’s footer.

action

Required.

Inside action, you must nest:

  • button field with your button’s content, and
  • at least one section object (maximum of 10).

Inside section, you must add at least one rows object.

Interactive- Document With Buttons (Link)

curl --location --request POST 'https://app.pingbix.com/WAApi/send' \
--form 'userid="Pingbix"' \
--form 'password="xxxxx"' \
--form 'wabaNumber="911234567890"' \
--form 'duplicatecheck="true"' \
--form 'mobile="919999999999"' \
--form 'sendMethod="quick"' \
--form 'msgType="reply"' \
--form 'scheduleTime="2022-01-20 00:00:00"' \
--form 'mediaType="document"' \
--form 'output="json"' \
--form 'msg="{
  \"header\": {
    \"type\": \"document\",
    \"document\": {
      \"link\": \"http(s)://the-url.pdf\",
       \"filename\":\"Sample.pdf\"
    }
  },
  \"body\": {
    \"text\": \"This is body\"
  },
  \"footer\": {
    \"text\": \"This is footer\"
  },
  \"action\": {
    \"buttons\": [
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id1\",
          \"title\": \"Button1\"
        }
      },
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id2\",
          \"title\": \"Button2\"
        }
      },
      {
        \"type\": \"reply\",
        \"reply\": {
          \"id\": \"id3\",
          \"title\": \"Button3\"
        }
      }
    ]
  }
}"'
FieldDescription
header

Optional.

If you decide to include it, you must set the header’s type to text and add a text field with the desired content.

body

Required.

Your message’s body.

footer

Required.

Your message’s footer.

action

Required.

Inside action, you must nest:

  • button field with your button’s content, and
  • at least one section object (maximum of 10).

Inside section, you must add at least one rows object.

🍪 This website uses cookies to improve your web experience.
Chat With Pingbix
1
💬 Chat With Us
Pingbix
Hello 👋
Can we help you?