Send a message

POST

meta

v25.0

{pageId}

messages

Send a message

curl --request POST \
  --url https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient.id": "<string>",
  "recipient.comment_id": "<string>",
  "message": {},
  "messaging_type": "<string>",
  "tag": "<string>",
  "sender_action": "<string>"
}
'

import requests

url = "https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages"

payload = {
    "recipient.id": "<string>",
    "recipient.comment_id": "<string>",
    "message": {},
    "messaging_type": "<string>",
    "tag": "<string>",
    "sender_action": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    'recipient.id': '<string>',
    'recipient.comment_id': '<string>',
    message: {},
    messaging_type: '<string>',
    tag: '<string>',
    sender_action: '<string>'
  })
};

fetch('https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'recipient.id' => '<string>',
    'recipient.comment_id' => '<string>',
    'message' => [
        
    ],
    'messaging_type' => '<string>',
    'tag' => '<string>',
    'sender_action' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages"

	payload := strings.NewReader("{\n  \"recipient.id\": \"<string>\",\n  \"recipient.comment_id\": \"<string>\",\n  \"message\": {},\n  \"messaging_type\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"sender_action\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipient.id\": \"<string>\",\n  \"recipient.comment_id\": \"<string>\",\n  \"message\": {},\n  \"messaging_type\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"sender_action\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recipient.id\": \"<string>\",\n  \"recipient.comment_id\": \"<string>\",\n  \"message\": {},\n  \"messaging_type\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"sender_action\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Send a Messenger message through a connected HookMyApp channel. Use the connected Page id in the path. Use the inbound sender.id as the outbound recipient.id. Supports:

text: Plain text replies
attachment: image, video, audio or file by public https URL
messaging_type: MESSAGE_TAG with tag: Send outside the 24-hour window
recipient.comment_id: Private reply to a comment, instead of recipient.id
sender_action: mark_seen, typing_on, typing_off

Authentication

Use the hmat_ channel token from GET /meta/channels/{id}/token or hookmyapp channels token <channel>. Do not use an hmok_ API key for this call.

Authorization: Bearer hmat_...

Path parameters

string

required

The connected Page id.

Request body

string

Page-scoped id (PSID) from the inbound webhook sender.id. Required unless recipient.comment_id is set.

string

A comment id on one of the Page’s posts, for a private reply. One per comment, within 7 days of the comment.

object

The message payload: text or attachment. Omit when sending a sender_action.

string

MESSAGE_TAG when sending outside the 24-hour window. Requires tag.

string

CONFIRMED_EVENT_UPDATE, POST_PURCHASE_UPDATE, ACCOUNT_UPDATE or HUMAN_AGENT.

string

mark_seen, typing_on or typing_off. Free, not counted as a message.

Example

curl -X POST "https://gateway.hookmyapp.com/meta/v25.0/{PAGE_ID}/messages" \
  -H "Authorization: Bearer hmat_..." \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": { "id": "200000000000001" },
    "message": { "text": "Hello from HookMyApp" }
  }'

Successful response

{
  "recipient_id": "200000000000001",
  "message_id": "m_AbCdEfGhIjKlMnOpQrSt"
}

Outside the 24-hour window

A free-form message to a person who last wrote more than 24 hours ago is rejected with HTTP 409: “This person last messaged you more than 24 hours ago. Send a message tag or wait for them to write again.” A person who cannot receive messages from your Page returns 409 too. Neither can succeed on retry. See Send messages for the guide.

Send a message

curl --request POST \
  --url https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient.id": "<string>",
  "recipient.comment_id": "<string>",
  "message": {},
  "messaging_type": "<string>",
  "tag": "<string>",
  "sender_action": "<string>"
}
'

import requests

url = "https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages"

payload = {
    "recipient.id": "<string>",
    "recipient.comment_id": "<string>",
    "message": {},
    "messaging_type": "<string>",
    "tag": "<string>",
    "sender_action": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    'recipient.id': '<string>',
    'recipient.comment_id': '<string>',
    message: {},
    messaging_type: '<string>',
    tag: '<string>',
    sender_action: '<string>'
  })
};

fetch('https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'recipient.id' => '<string>',
    'recipient.comment_id' => '<string>',
    'message' => [
        
    ],
    'messaging_type' => '<string>',
    'tag' => '<string>',
    'sender_action' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages"

	payload := strings.NewReader("{\n  \"recipient.id\": \"<string>\",\n  \"recipient.comment_id\": \"<string>\",\n  \"message\": {},\n  \"messaging_type\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"sender_action\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipient.id\": \"<string>\",\n  \"recipient.comment_id\": \"<string>\",\n  \"message\": {},\n  \"messaging_type\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"sender_action\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway.hookmyapp.com/meta/v25.0/{pageId}/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recipient.id\": \"<string>\",\n  \"recipient.comment_id\": \"<string>\",\n  \"message\": {},\n  \"messaging_type\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"sender_action\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Getting started

Sending & receiving

Publish & engage

Tools

API Reference

Authentication

Path parameters

Request body

Example

Successful response

Outside the 24-hour window

​Authentication

​Path parameters

​Request body

​Example

​Successful response

​Outside the 24-hour window

Authentication

Path parameters

Request body

Example

Successful response

Outside the 24-hour window