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

Path parameters

contactIdstringRequired

Query parameters

limitstringOptional

pagestringOptional

searchTextstringOptional

Header parameters

x-api-keystringRequired

Responses

application/json

object[]Optional

get

HTTPcURLJavaScriptPython

GET /v1/messages/{contactId} HTTP/1.1
Host: Your Host
x-api-key: text
Accept: */*

200

200 response

[
  {
    "id": "text",
    "contact": {
      "id": "text",
      "channel": "text",
      "phoneNumber": "text"
    },
    "channel": "text",
    "isIncoming": true,
    "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.

post

Authorizations

Header parameters

x-api-keystringRequired

Body

clientobjectOptional

contactobjectOptional

recepientobjectOptional

scheduleDateTimestringOptional

templateobjectRequired

headerMediaUrlstringOptional

headerTextParametersstring[]Optional

bodyTextParametersstring[]Optional

buttonUrlParametersstring[]Optional

locationParametersobjectOptional

flowParametersobjectOptional

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/whatsapp/sendtemplate HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 447

{
  "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": 1,
    "longitude": 1,
    "address": "text",
    "name": "text"
  },
  "flowParameters": {
    "flowToken": "text",
    "flowData": "text"
  },
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "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": 1,
    "longitude": 1,
    "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"
}

post

Header parameters

x-api-keystringRequired

Body

clientobjectOptional

contactobjectOptional

recepientobjectOptional

scheduleDateTimestringOptional

mimeTypestringRequired

mediaUrlstringRequired

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/whatsapp/sendmedia HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "client": {
    "id": "text"
  },
  "contact": {
    "id": "text"
  },
  "recepient": {
    "phoneNumber": "text"
  },
  "scheduleDateTime": "text",
  "mimeType": "text",
  "mediaUrl": "text",
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "success": true
}

post

Header parameters

x-api-keystringRequired

Body

clientobjectOptional

contactobjectOptional

recepientobjectOptional

scheduleDateTimestringOptional

textMessagestringRequired

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/whatsapp/sendtext HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "client": {
    "id": "text"
  },
  "contact": {
    "id": "text"
  },
  "recepient": {
    "phoneNumber": "text"
  },
  "scheduleDateTime": "text",
  "textMessage": "text",
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "success": true
}

Telegram

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

scheduleDateTimestringOptional

mimeTypestringRequired

mediaUrlstringRequired

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/telegram/sendmedia HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "mimeType": "text",
  "mediaUrl": "text",
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "success": true
}

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

scheduleDateTimestringOptional

textMessagestringRequired

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/telegram/sendtext HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "textMessage": "text",
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "success": true
}

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

locationobjectRequired

headerTypestring · enumOptionalAvailable options:

mimeTypestringOptional

mediaUrlstringOptional

textMessagestringRequired

buttonsobject[] · min: 1Required

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/telegram/sendtemplate HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "contact": {
    "id": "text"
  },
  "location": {
    "id": "text"
  },
  "headerType": "IMAGE",
  "mimeType": "text",
  "mediaUrl": "text",
  "textMessage": "text",
  "buttons": [
    {
      "type": "web_url",
      "title": "text",
      "payload": "text",
      "url": "text"
    }
  ]
}

200

200 response

{
  "success": true
}

Instagram

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

scheduleDateTimestringOptional

mimeTypestringRequired

mediaUrlstringRequired

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/instagram/sendmedia HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "mimeType": "text",
  "mediaUrl": "text",
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "success": true
}

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

locationobjectRequired

elementsobject[] · min: 1Required

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/instagram/sendtemplate HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "contact": {
    "id": "text"
  },
  "location": {
    "id": "text"
  },
  "elements": [
    {
      "title": "text",
      "subtitle": "text",
      "image_url": "text",
      "default_action": {
        "type": "text",
        "url": "text"
      },
      "buttons": [
        {
          "type": "web_url",
          "title": "text",
          "payload": "text",
          "url": "text"
        }
      ]
    }
  ]
}

200

200 response

{
  "success": true
}

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

scheduleDateTimestringOptional

textMessagestringRequired

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/instagram/sendtext HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "textMessage": "text",
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "success": true
}

Messenger

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

scheduleDateTimestringOptional

mimeTypestringRequired

mediaUrlstringRequired

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/messenger/sendmedia HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "mimeType": "text",
  "mediaUrl": "text",
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "success": true
}

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

locationobjectRequired

elementsobject[] · min: 1Required

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/messenger/sendtemplate HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "contact": {
    "id": "text"
  },
  "location": {
    "id": "text"
  },
  "elements": [
    {
      "title": "text",
      "subtitle": "text",
      "image_url": "text",
      "default_action": {
        "type": "text",
        "url": "text"
      },
      "buttons": [
        {
          "type": "web_url",
          "title": "text",
          "payload": "text",
          "url": "text"
        }
      ]
    }
  ]
}

200

200 response

{
  "success": true
}

post

Header parameters

x-api-keystringRequired

Body

contactobjectRequired

scheduleDateTimestringOptional

textMessagestringRequired

locationobjectRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v1/messages/messenger/sendtext HTTP/1.1
Host: Your Host
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "contact": {
    "id": "text"
  },
  "scheduleDateTime": "text",
  "textMessage": "text",
  "location": {
    "id": "text"
  }
}

200

200 response

{
  "success": true
}