Send a message

POST

meta

v25.0

{instagramAccountId}

messages

Send a message

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

import requests

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

payload = {
    "recipient.id": "<string>",
    "message": {}
}
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>', message: {}})
};

fetch('https://gateway.hookmyapp.com/meta/v25.0/{instagramAccountId}/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/{instagramAccountId}/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>',
    'message' => [
        
    ]
  ]),
  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/{instagramAccountId}/messages"

	payload := strings.NewReader("{\n  \"recipient.id\": \"<string>\",\n  \"message\": {}\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/{instagramAccountId}/messages")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipient.id\": \"<string>\",\n  \"message\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway.hookmyapp.com/meta/v25.0/{instagramAccountId}/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  \"message\": {}\n}"

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

Send an Instagram DM through a connected HookMyApp channel. Use the connected Instagram account ID in the path. Use the inbound sender.id as the outbound recipient.id. Supports Instagram message types:

text: Plain text replies
image, audio, video: Media messages
quick_replies: Quick reply prompts
generic cards: Cards and carousels
reaction: Message reactions
sender_action: Typing indicators and other sender actions

Authentication

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

Authorization: Bearer hmat_...

Path parameters

string

required

The connected Instagram account ID.

Request body

string

required

Instagram-scoped sender ID (IGSID) from the inbound webhook sender.id.

object

required

The Instagram message payload, such as text, media attachment, quick replies, cards, reactions, or sender actions.

Example

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

Successful response

{
  "recipient_id": "17841400000000001",
  "message_id": "m_0AbCdEfGhIjKlMnOpQrSt"
}

Supported message types

Use the guide pages for copy-paste examples:

Instagram enforces the standard messaging window. Plain replies outside the allowed window are rejected by Meta.

Send a message

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

import requests

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

payload = {
    "recipient.id": "<string>",
    "message": {}
}
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>', message: {}})
};

fetch('https://gateway.hookmyapp.com/meta/v25.0/{instagramAccountId}/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/{instagramAccountId}/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>',
    'message' => [
        
    ]
  ]),
  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/{instagramAccountId}/messages"

	payload := strings.NewReader("{\n  \"recipient.id\": \"<string>\",\n  \"message\": {}\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/{instagramAccountId}/messages")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipient.id\": \"<string>\",\n  \"message\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway.hookmyapp.com/meta/v25.0/{instagramAccountId}/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  \"message\": {}\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

Supported message types

​Authentication

​Path parameters

​Request body

​Example

​Successful response

​Supported message types

Authentication

Path parameters

Request body

Example

Successful response

Supported message types