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

JavaScriptCurl

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

Response

[
  {
    "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 initiate template messages to a contact if there is no active session (24 hr period). Media and Text Messages will be delivered when there is an active session.

POSTYour Host/v1/messages/whatsapp/sendtemplate

Header parameters

Body

application/json

clientobject

contactobject

recepientobject

scheduleDateTimestring

template*object

headerMediaUrlstring

headerTextParametersarray of string

bodyTextParametersarray of string

buttonUrlParametersarray of string

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

location*object

Request

JavaScriptCurl

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

Response

{
  "client": {
    "id": "text"
  },
  "contact": {
    "id": "text"
  },
  "recepient": {
    "phoneNumber": "text"
  },
  "scheduleDateTime": "text",
  "template": {
    "name": "text",
    "language": "text"
  },
  "headerMediaUrl": "text",
  "headerTextParameters": [
    "text"
  ],
  "bodyTextParameters": [
    "text"
  ],
  "buttonUrlParameters": [
    "text"
  ],
  "location": {
    "id": "text"
  }
}

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

JavaScriptCurl

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

Response

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

JavaScriptCurl

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

Response

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

JavaScriptCurl

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

Response

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

JavaScriptCurl

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

Response

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

JavaScriptCurl

const response = await fetch('Your Host/v1/messages/telegram/sendtemplate', {
    method: 'POST',
    headers: {
      "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

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

JavaScriptCurl

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

Response

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

JavaScriptCurl

const response = await fetch('Your Host/v1/messages/instagram/sendtemplate', {
    method: 'POST',
    headers: {
      "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

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

JavaScriptCurl

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

Response

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

JavaScriptCurl

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

Response

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

JavaScriptCurl

const response = await fetch('Your Host/v1/messages/messenger/sendtemplate', {
    method: 'POST',
    headers: {
      "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

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

JavaScriptCurl

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

Response

{
  "success": false
}