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

GETYour Host/v1/messages/{contactId}

Path parameters

contactId*string

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

contactobject

channelstring

isIncomingboolean

typestring

sentBystring

statusstring

errorMessagestring

mediaUrlstring

textstring

footerTextstring

optionsobject

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/{contactId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

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

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.

POSTYour Host/v1/messages/whatsapp/sendtemplate

Authorization

api_key

Header parameters

Body

application/json

clientobject

contactobject

recepientobject

scheduleDateTimestring

template*object

headerMediaUrlstring

headerTextParametersarray of string

bodyTextParametersarray of string

buttonUrlParametersarray of string

locationParametersobject

flowParametersobject

location*object

Response

200

200 response

Body

application/json

clientobject

contactobject

recepientobject

scheduleDateTimestring

template*object

headerMediaUrlstring

headerTextParametersarray of string

bodyTextParametersarray of string

buttonUrlParametersarray of string

locationParametersobject

flowParametersobject

location*object

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/whatsapp/sendtemplate', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "location": {
        "id": "text"
      },
      "template": {
        "language": "text",
        "name": "text"
      }
    }),
});
const data = await response.json();

Response

200

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

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"
}

POSTYour Host/v1/messages/whatsapp/sendmedia

Header parameters

Body

application/json

clientobject

contactobject

recepientobject

scheduleDateTimestring

mimeType*string

mediaUrl*string

location*object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/whatsapp/sendmedia', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "location": {
        "id": "text"
      },
      "mediaUrl": "text",
      "mimeType": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

POSTYour Host/v1/messages/whatsapp/sendtext

Header parameters

Body

application/json

clientobject

contactobject

recepientobject

scheduleDateTimestring

textMessage*string

location*object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/whatsapp/sendtext', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "location": {
        "id": "text"
      },
      "textMessage": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

Telegram

POSTYour Host/v1/messages/telegram/sendmedia

Header parameters

Body

application/json

contact*object

scheduleDateTimestring

mimeType*string

mediaUrl*string

location*object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/telegram/sendmedia', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contact": {
        "id": "text"
      },
      "location": {
        "id": "text"
      },
      "mediaUrl": "text",
      "mimeType": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

POSTYour Host/v1/messages/telegram/sendtext

Header parameters

Body

application/json

contact*object

scheduleDateTimestring

textMessage*string

location*object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/telegram/sendtext', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contact": {
        "id": "text"
      },
      "location": {
        "id": "text"
      },
      "textMessage": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

POSTYour Host/v1/messages/telegram/sendtemplate

Header parameters

Body

application/json

contact*object

location*object

headerTypeenum

IMAGEVIDEODOCUMENT

mimeTypestring

mediaUrlstring

textMessage*string

buttons*array of object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/telegram/sendtemplate', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "buttons": [
        {
          "title": "text",
          "type": "web_url"
        }
      ],
      "contact": {
        "id": "text"
      },
      "location": {
        "id": "text"
      },
      "textMessage": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

Instagram

POSTYour Host/v1/messages/instagram/sendmedia

Header parameters

Body

application/json

contact*object

scheduleDateTimestring

mimeType*string

mediaUrl*string

location*object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/instagram/sendmedia', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contact": {
        "id": "text"
      },
      "location": {
        "id": "text"
      },
      "mediaUrl": "text",
      "mimeType": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

POSTYour Host/v1/messages/instagram/sendtemplate

Header parameters

Body

application/json

contact*object

location*object

elements*array of object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/instagram/sendtemplate', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contact": {
        "id": "text"
      },
      "elements": [
        {
          "buttons": [
            {
              "title": "text",
              "type": "web_url"
            }
          ],
          "title": "text"
        }
      ],
      "location": {
        "id": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

POSTYour Host/v1/messages/instagram/sendtext

Header parameters

Body

application/json

contact*object

scheduleDateTimestring

textMessage*string

location*object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/instagram/sendtext', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contact": {
        "id": "text"
      },
      "location": {
        "id": "text"
      },
      "textMessage": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

Messenger

POSTYour Host/v1/messages/messenger/sendmedia

Header parameters

Body

application/json

contact*object

scheduleDateTimestring

mimeType*string

mediaUrl*string

location*object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/messenger/sendmedia', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contact": {
        "id": "text"
      },
      "location": {
        "id": "text"
      },
      "mediaUrl": "text",
      "mimeType": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

POSTYour Host/v1/messages/messenger/sendtemplate

Header parameters

Body

application/json

contact*object

location*object

elements*array of object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/messenger/sendtemplate', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contact": {
        "id": "text"
      },
      "elements": [
        {
          "buttons": [
            {
              "title": "text",
              "type": "web_url"
            }
          ],
          "title": "text"
        }
      ],
      "location": {
        "id": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}

POSTYour Host/v1/messages/messenger/sendtext

Header parameters

Body

application/json

contact*object

scheduleDateTimestring

textMessage*string

location*object

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('Your Host/v1/messages/messenger/sendtext', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contact": {
        "id": "text"
      },
      "location": {
        "id": "text"
      },
      "textMessage": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false
}