Skip to main content
POST
/
v1
/
typing
Send typing indicator
curl --request POST \
  --url https://api.messages.dev/v1/typing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "+15551234567",
  "to": "+15559876543",
  "state": "on"
}
'
import requests

url = "https://api.messages.dev/v1/typing"

payload = {
    "from": "+15551234567",
    "to": "+15559876543",
    "state": "on"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({from: '+15551234567', to: '+15559876543', state: 'on'})
};

fetch('https://api.messages.dev/v1/typing', 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.messages.dev/v1/typing",
  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([
    'from' => '+15551234567',
    'to' => '+15559876543',
    'state' => 'on'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://api.messages.dev/v1/typing"

	payload := strings.NewReader("{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"state\": \"on\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.messages.dev/v1/typing")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"state\": \"on\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.messages.dev/v1/typing")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"state\": \"on\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "status": "<string>",
  "request_id": "<string>"
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "missing_required_parameter",
    "message": "The 'from' query parameter is required.",
    "param": "from"
  },
  "request_id": "req_abc123"
}
{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Missing Authorization header. Use 'Authorization: Bearer sk_live_...'"
  },
  "request_id": "req_abc123"
}

Authorizations

Authorization
string
header
required

Use an API key as a bearer token: Authorization: Bearer sk_live_...

Each key has a set of scopes that gate which endpoints it can call: messages:read, messages:write, chats:read, lines:read, reactions:read, reactions:write, typing:read, typing:write, receipts:read, receipts:write, webhooks:read, webhooks:write, outbox:read, files:read, files:write. Keys can also be restricted to a subset of lines.

Body

application/json
from
string
required

Sender line handle (phone number or Apple ID)

Example:

"+15551234567"

to
string
required

Recipient handle

Example:

"+15559876543"

state
enum<string>
default:on

Typing state. Defaults to on.

Available options:
on,
off

Response

Outbox item created

id
string

Delivery ID (e.g. obx_abc123)

status
string
Allowed value: "pending"
request_id
string