Get message history from a conversation
Get the 50 most recent messages from a conversation by phone number and inbox.
curl --request GET \
--url https://api.heymarket.com/v1/messages \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heymarket.com/v1/messages"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heymarket.com/v1/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://api.heymarket.com/v1/messages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.heymarket.com/v1/messages"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heymarket.com/v1/messages")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"author": "<string>",
"broadcast_id": 123,
"conversation": {
"assigned": 123,
"blocked": true,
"channel": "<string>",
"created": "<string>",
"creator": 123,
"email_noti": true,
"id": 123,
"inbox": 123,
"last_inbound": 123,
"local_id": "<string>",
"members": [
{
"id": 123,
"name": "<string>"
}
],
"muted": true,
"name": "<string>",
"noreply": "<string>",
"op": "<string>",
"read": 123,
"replied": true,
"snooze_till": "<string>",
"status": "<string>",
"super": 123,
"support": true,
"target": "<string>",
"type": "<string>",
"updated": "<string>"
},
"custom": {
"data": [
123
],
"type": "<string>"
},
"date": "<string>",
"flagged": true,
"id": 123,
"link_url": "<string>",
"local_id": "<string>",
"media": "<string>",
"phone": "<string>",
"raw_error": "<string>",
"status": "<string>",
"super": 123,
"support": true,
"target": "<string>",
"target_errors": {},
"text": "<string>",
"type": "<string>",
"updated": "<string>",
"user": 123
}
]"<string>"Unauthorizedtoo many requestserrorAuthorizations
Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.
API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.
Use the following JWT values:
{
"alg": "HS256",
"typ": "JWT"
}
{
"iss": "YOUR_API_SECRET_ID",
"iat": CURRENT_UNIX_TIMESTAMP
}
Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.
Sign the JWT with HMAC-SHA256 using this signing secret:
YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY
Send the signed JWT as a bearer token:
Authorization: Bearer YOUR_SIGNED_JWT
Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.
Query Parameters
Phone Number
Inbox ID
Latest time to search
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Failure reason for an outbound message. Set when status is failed, undelivered, dropped, or bounce.
Failure detail for an outbound message. Keyed by target for carrier and group failures; some channels key it by provider metadata (provider, message, status_code) instead.
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://api.heymarket.com/v1/messages \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heymarket.com/v1/messages"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heymarket.com/v1/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://api.heymarket.com/v1/messages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.heymarket.com/v1/messages"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heymarket.com/v1/messages")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"author": "<string>",
"broadcast_id": 123,
"conversation": {
"assigned": 123,
"blocked": true,
"channel": "<string>",
"created": "<string>",
"creator": 123,
"email_noti": true,
"id": 123,
"inbox": 123,
"last_inbound": 123,
"local_id": "<string>",
"members": [
{
"id": 123,
"name": "<string>"
}
],
"muted": true,
"name": "<string>",
"noreply": "<string>",
"op": "<string>",
"read": 123,
"replied": true,
"snooze_till": "<string>",
"status": "<string>",
"super": 123,
"support": true,
"target": "<string>",
"type": "<string>",
"updated": "<string>"
},
"custom": {
"data": [
123
],
"type": "<string>"
},
"date": "<string>",
"flagged": true,
"id": 123,
"link_url": "<string>",
"local_id": "<string>",
"media": "<string>",
"phone": "<string>",
"raw_error": "<string>",
"status": "<string>",
"super": 123,
"support": true,
"target": "<string>",
"target_errors": {},
"text": "<string>",
"type": "<string>",
"updated": "<string>",
"user": 123
}
]"<string>"Unauthorizedtoo many requestserror