Skip to main content
POST
/
api
/
v2
/
message
Mensajes de contactos
curl --request POST \
  --url https://whatsapp.heybot.cloud/api/v2/message \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "contacts": [
    {
      "name": {
        "formatted_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>",
        "prefix": "<string>"
      },
      "phones": [
        {
          "phone": "<string>",
          "type": "<string>"
        }
      ],
      "emails": [
        {
          "email": "<string>",
          "type": "<string>"
        }
      ],
      "addresses": [
        {
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "country": "<string>",
          "country_code": "<string>",
          "type": "<string>"
        }
      ],
      "org": {
        "company": "<string>",
        "department": "<string>",
        "title": "<string>"
      },
      "birthday": "<string>",
      "urls": [
        {
          "url": "<string>",
          "type": "<string>"
        }
      ]
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.heybot.cloud/llms.txt

Use this file to discover all available pages before exploring further.

type
string
default:"contacts"
required
The type of message being sent.
contacts
array
required
An array containing the contact objects you want to send.

Ejemplo

{
  "to": 5219876543210,
  "type": "contacts",
  "contacts": [
    {
      "addresses": [
        {
          "street": "<STREET_NUMBER_AND_NAME>",
          "city": "<CITY>",
          "state": "<STATE_CODE>",
          "zip": "<ZIP_CODE>",
          "country": "<COUNTRY_NAME>",
          "country_code": "<COUNTRY_CODE>",
          "type": "<ADDRESS_TYPE>"
        }
        <!-- Additional addresses objects go here, if using -->
      ],
      "birthday": "<BIRTHDAY>",
      "emails": [
        {
          "email": "<EMAIL_ADDRESS>",
          "type": "<EMAIL_TYPE>"
        }
        <!-- Additional emails objects go here, if using -->
      ],
      "name": {
        "formatted_name": "<FULL_NAME>",
        "first_name": "<FIRST_NAME>",
        "last_name": "<LAST_NAME>",
        "middle_name": "<MIDDLE_NAME>",
        "suffix": "<SUFFIX>",
        "prefix": "<PREFIX>"
      },
      "org": {
        "company": "<COMPANY_OR_ORG_NAME>",
        "department": "<DEPARTMENT_NAME>",
        "title": "<JOB_TITLE>"
      },
      "phones": [
          "phone": "<PHONE_NUMBER>",
          "type": "<PHONE_NUMBER_TYPE>"
        }
        <!-- Additional phones objects go here, if using -->
      ],
      "urls": [
        {
          "url": "<WEBSITE_URL>",
          "type": "<WEBSITE_TYPE>"
        }
        <!-- Additional URLs go here, if using -->
      ]
    }
  ]
}