Messages

Use our omnichannel API to send messages across multiple channels using our API.

Effective and efficient communication remains pivotal for businesses seeking to engage with their customers in the ever-evolving digital landscape. Recognising this need, Whautomate's Messages Endpoint emerges as a versatile and powerful tool, designed to streamline and enhance your messaging capabilities across multiple popular platforms, including Telegram, Instagram, WhatsApp, and Messenger.

Get Messages of Contact

get

/v1/messages/{contactId}

Path parameters

contactIdstringrequired

Query parameters

limitstring

pagestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'Your Host/v1/messages/{contactId}' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "channel": "text",
    "isIncoming": true,
    "type": "text",
    "sentBy": "text",
    "status": "text",
    "errorMessage": "text",
    "mediaUrl": "text",
    "text": "text",
    "footerText": "text",
    "contact": {
      "id": "text",
      "channel": "text",
      "phoneNumber": "text"
    },
    "options": {
      "type": "text",
      "buttons": [
        {
          "type": "text",
          "text": "text",
          "url": "text"
        }
      ]
    }
  }
]

200 response

WhatsApp

Please note you can only send Media and Text Messages when there is an active session (24 hr period). You can send template messages to a contact any time even if there is no active session. You can send WhatsApp messages to

• Contact

• Client

• Recepient

Simply send the message to a recepient with phoneNumber and name, the platform will create or use the existing contact in your account. If you already have a contact or Client created in Whautomate and you have those identifiers, use those identifiers to send the message to them. If not use recepient instead.

post

/v1/messages/whatsapp/sendtemplate

Authorizations

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

headerMediaUrlstring

headerTextParametersstring[]

bodyTextParametersstring[]

buttonUrlParametersstring[]

clientobject

contactobject

recepientobject

templateobjectrequired

locationParametersobject

flowParametersobject

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/whatsapp/sendtemplate' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"headerTextParameters":[null],"bodyTextParameters":[null],"buttonUrlParameters":[null],"client":{"id":"text"},"contact":{"id":"text"},"recepient":{"phoneNumber":"text"},"template":{"name":"text","language":"text"},"locationParameters":{"latitude":1,"longitude":1,"address":"text","name":"text"},"flowParameters":{"flowToken":"text","flowData":"text"},"location":{"id":"text"}}'

200

200

{
  "scheduleDateTime": "text",
  "headerMediaUrl": "text",
  "headerTextParameters": [
    "text"
  ],
  "bodyTextParameters": [
    "text"
  ],
  "buttonUrlParameters": [
    "text"
  ],
  "client": {
    "id": "text"
  },
  "contact": {
    "id": "text"
  },
  "recepient": {
    "phoneNumber": "text"
  },
  "template": {
    "name": "text",
    "language": "text"
  },
  "locationParameters": {
    "latitude": 1,
    "longitude": 1,
    "address": "text",
    "name": "text"
  },
  "flowParameters": {
    "flowToken": "text",
    "flowData": "text"
  },
  "location": {
    "id": "text"
  }
}

200 response

POST /users

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
  "id": 1,
  "name": "John",
  "age": 30
}

400

{
  "error": "Invalid request"
}

post

/v1/messages/whatsapp/sendmedia

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

mimeTypestringrequired

mediaUrlstringrequired

clientobject

contactobject

recepientobject

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/whatsapp/sendmedia' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"mimeType":"text","mediaUrl":"text","client":{"id":"text"},"contact":{"id":"text"},"recepient":{"phoneNumber":"text"},"location":{"id":"text"}}'

200

200

{
  "success": true
}

200 response

post

/v1/messages/whatsapp/sendtext

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

textMessagestringrequired

clientobject

contactobject

recepientobject

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/whatsapp/sendtext' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"textMessage":"text","client":{"id":"text"},"contact":{"id":"text"},"recepient":{"phoneNumber":"text"},"location":{"id":"text"}}'

200

200

{
  "success": true
}

200 response

Telegram

post

/v1/messages/telegram/sendmedia

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

mimeTypestringrequired

mediaUrlstringrequired

contactobjectrequired

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/telegram/sendmedia' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"mimeType":"text","mediaUrl":"text","contact":{"id":"text"},"location":{"id":"text"}}'

200

200

{
  "success": true
}

200 response

post

/v1/messages/telegram/sendtext

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

textMessagestringrequired

contactobjectrequired

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/telegram/sendtext' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"textMessage":"text","contact":{"id":"text"},"location":{"id":"text"}}'

200

200

{
  "success": true
}

200 response

post

/v1/messages/telegram/sendtemplate

Header parameters

x-api-keystringrequired

Body

mimeTypestring

mediaUrlstring

textMessagestringrequired

headerTypestring · enum

Options: IMAGE, VIDEO, DOCUMENT

contactobjectrequired

locationobjectrequired

buttonsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/telegram/sendtemplate' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"textMessage":"text","headerType":"IMAGE","contact":{"id":"text"},"location":{"id":"text"},"buttons":[{"title":"text","type":"web_url"}]}'

200

200

{
  "success": true
}

200 response

Instagram

post

/v1/messages/instagram/sendmedia

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

mimeTypestringrequired

mediaUrlstringrequired

contactobjectrequired

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/instagram/sendmedia' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"mimeType":"text","mediaUrl":"text","contact":{"id":"text"},"location":{"id":"text"}}'

200

200

{
  "success": true
}

200 response

post

/v1/messages/instagram/sendtemplate

Header parameters

x-api-keystringrequired

Body

contactobjectrequired

locationobjectrequired

elementsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/instagram/sendtemplate' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"contact":{"id":"text"},"location":{"id":"text"},"elements":[{"title":"text","default_action":{"type":"text","url":"text"},"buttons":[{"title":"text","type":"web_url"}]}]}'

200

200

{
  "success": true
}

200 response

post

/v1/messages/instagram/sendtext

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

textMessagestringrequired

contactobjectrequired

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/instagram/sendtext' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"textMessage":"text","contact":{"id":"text"},"location":{"id":"text"}}'

200

200

{
  "success": true
}

200 response

Messenger

post

/v1/messages/messenger/sendmedia

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

mimeTypestringrequired

mediaUrlstringrequired

contactobjectrequired

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/messenger/sendmedia' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"mimeType":"text","mediaUrl":"text","contact":{"id":"text"},"location":{"id":"text"}}'

200

200

{
  "success": true
}

200 response

post

/v1/messages/messenger/sendtemplate

Header parameters

x-api-keystringrequired

Body

contactobjectrequired

locationobjectrequired

elementsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/messenger/sendtemplate' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"contact":{"id":"text"},"location":{"id":"text"},"elements":[{"title":"text","default_action":{"type":"text","url":"text"},"buttons":[{"title":"text","type":"web_url"}]}]}'

200

200

{
  "success": true
}

200 response

post

/v1/messages/messenger/sendtext

Header parameters

x-api-keystringrequired

Body

scheduleDateTimestring

textMessagestringrequired

contactobjectrequired

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'Your Host/v1/messages/messenger/sendtext' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"textMessage":"text","contact":{"id":"text"},"location":{"id":"text"}}'

200

200

{
  "success": true
}

200 response