Send Message

Send a direct message to a recipient

POST /messages/:platform

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"message": "What's up!", "recipientId": "283j839222"} \
-X POST https://api.ayrshare.com/api/messages/instagram

const apiKey = 'API_KEY';
const url = 'https://api.ayrshare.com/api/messages/instagram';

const data = {
  message: "What's up!",
  recipientId: '283j839222',
};

const headers = {
  'Authorization': `Bearer ${apiKey}`,
  'Content-Type': 'application/json',
};

fetch(url, {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(data),
})
  .then(response => response.json())
  .then(data => {
    console.log('Response:', data);
  })
  .catch(error => {
    console.error('Error:', error);
  });

import requests

api_key = 'API_KEY'
url = 'https://api.ayrshare.com/api/messages/instagram'

data = {
    'message': "What's up!",
    'recipientId': '283j839222',
}

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json',
}

response = requests.post(url, json=data, headers=headers)
print('Response:', response.json())

<?php

$apiKey = 'API_KEY';
$url = 'https://api.ayrshare.com/api/messages/instagram';

$data = [
    'message' => "What's up!",
    'recipientId' => '283j839222',
];

$headers = [
    'Authorization: Bearer ' . $apiKey,
    'Content-Type: application/json',
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

if ($response === false) {
    $error = curl_error($ch);
    echo 'Error: ' . $error;
} else {
    $responseData = json_decode($response, true);
    print_r($responseData);
}

curl_close($ch);

?>

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        string apiKey = "API_KEY";
        string url = "https://api.ayrshare.com/api/messages/instagram";

        var data = new
        {
            message = "What's up!",
            recipientId = "283j839222"
        };

        var jsonData = JsonSerializer.Serialize(data);

        using var client = new HttpClient();
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

        var content = new StringContent(jsonData, Encoding.UTF8, "application/json");

        try
        {
            var response = await client.PostAsync(url, content);
            response.EnsureSuccessStatusCode();

            var responseBody = await response.Content.ReadAsStringAsync();
            var responseData = JsonSerializer.Deserialize<dynamic>(responseBody);

            Console.WriteLine("Response:");
            Console.WriteLine(responseData);
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) {
        String apiKey = "API_KEY";
        String url = "https://api.ayrshare.com/api/messages/instagram";

        String data = "{\"message\": \"What's up!\", \"recipientId\": \"283j839222\"}";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Authorization", "Bearer " + apiKey)
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(data))
                .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

            if (response.statusCode() == 200) {
                String responseBody = response.body();
                System.out.println("Response:");
                System.out.println(responseBody);
            } else {
                System.out.println("Request failed. Status code: " + response.statusCode());
            }
        } catch (IOException | InterruptedException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}

200: Success

{ // single text message
    "status": "success",
    "recipientId": "72706337063589124",
    "messageId": "aWdfZAG1faXRlbToxOkl",
    "message": "What is up?"
}

{
  // single text message
  "action": "messages",
  "status": "error",
  "code": 363,
  "message": "The recipient ID was not found. Please confirm the recipient ID is correct."
}

{
  // single image
  "status": "success",
  "recipientId": "761943",
  "messageId": "m_EgvfBrgjaM",
  "type": "image",
  "mediaUrl": "https://img.ayrshare.com/012/gb.jpg"
}

{
  // text and image message
  "action": "send",
  "status": "error",
  "code": 337,
  "message": "Error sending message.",
  "messages": [
    {
      "recipientId": "727063370635",
      "messageId": "aWdfZAG1faXRlbT",
      "message": "What a great day"
    },
    {
      "action": "messages",
      "status": "error",
      "code": 365,
      "message": "An error occurred sending the message attachment. Please verify the attachment is still available and try again."
    }
  ]
}

Send a new direct message to a recipient.

Pricing & Limits: Each User Profile can have up to 1,000 active conversations per billing cycle across all social networks. Pricing depends on your plan: Premium plans pay a flat $49 per month** add-on, while **Launch** and **Business** plans are billed at **$0.09 per active conversation. A conversation is counted as active when you send a message to a recipient during the billing cycle; inbound messages alone do not count. The number of messages within an active conversation is unlimited.

• You can send an emoji as part of the message text.

• Facebook and Instagram mediaUrls must end in a known extension. Including query parameters will cause the media url to fail.

Header Parameters

Path Parameters

platform · string · required

The platform to send the message: facebook, instagram, twitter

Body Parameters

recipientId · string · required

The ID of the message recipient.

message · string · required

The message to send to the recipient.

• Facebook and Instagram message may be an empty string or not included if a mediaUrls is provided.

• X requires a message of at least one character even if a mediaUrls is provided.

mediaUrls · array

Array of media URLS for attaching images, a video, or a voice message.

• URLs of media items should end in the file extension without additional parameters appended.

• Facebook and Instagram support multiple media URLs.
• X only accepts a single media URL.
• Voice messages are supported on Facebook and Instagram as an aac or wav file.

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"message": "What's up!", "recipientId": "283j839222"} \
-X POST https://api.ayrshare.com/api/messages/instagram

const apiKey = 'API_KEY';
const url = 'https://api.ayrshare.com/api/messages/instagram';

const data = {
  message: "What's up!",
  recipientId: '283j839222',
};

const headers = {
  'Authorization': `Bearer ${apiKey}`,
  'Content-Type': 'application/json',
};

fetch(url, {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(data),
})
  .then(response => response.json())
  .then(data => {
    console.log('Response:', data);
  })
  .catch(error => {
    console.error('Error:', error);
  });

import requests

api_key = 'API_KEY'
url = 'https://api.ayrshare.com/api/messages/instagram'

data = {
    'message': "What's up!",
    'recipientId': '283j839222',
}

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json',
}

response = requests.post(url, json=data, headers=headers)
print('Response:', response.json())

<?php

$apiKey = 'API_KEY';
$url = 'https://api.ayrshare.com/api/messages/instagram';

$data = [
    'message' => "What's up!",
    'recipientId' => '283j839222',
];

$headers = [
    'Authorization: Bearer ' . $apiKey,
    'Content-Type: application/json',
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

if ($response === false) {
    $error = curl_error($ch);
    echo 'Error: ' . $error;
} else {
    $responseData = json_decode($response, true);
    print_r($responseData);
}

curl_close($ch);

?>

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        string apiKey = "API_KEY";
        string url = "https://api.ayrshare.com/api/messages/instagram";

        var data = new
        {
            message = "What's up!",
            recipientId = "283j839222"
        };

        var jsonData = JsonSerializer.Serialize(data);

        using var client = new HttpClient();
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

        var content = new StringContent(jsonData, Encoding.UTF8, "application/json");

        try
        {
            var response = await client.PostAsync(url, content);
            response.EnsureSuccessStatusCode();

            var responseBody = await response.Content.ReadAsStringAsync();
            var responseData = JsonSerializer.Deserialize<dynamic>(responseBody);

            Console.WriteLine("Response:");
            Console.WriteLine(responseData);
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) {
        String apiKey = "API_KEY";
        String url = "https://api.ayrshare.com/api/messages/instagram";

        String data = "{\"message\": \"What's up!\", \"recipientId\": \"283j839222\"}";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Authorization", "Bearer " + apiKey)
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(data))
                .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

            if (response.statusCode() == 200) {
                String responseBody = response.body();
                System.out.println("Response:");
                System.out.println(responseBody);
            } else {
                System.out.println("Request failed. Status code: " + response.statusCode());
            }
        } catch (IOException | InterruptedException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}

200: Success

{ // single text message
    "status": "success",
    "recipientId": "72706337063589124",
    "messageId": "aWdfZAG1faXRlbToxOkl",
    "message": "What is up?"
}

{
  // single text message
  "action": "messages",
  "status": "error",
  "code": 363,
  "message": "The recipient ID was not found. Please confirm the recipient ID is correct."
}

{
  // single image
  "status": "success",
  "recipientId": "761943",
  "messageId": "m_EgvfBrgjaM",
  "type": "image",
  "mediaUrl": "https://img.ayrshare.com/012/gb.jpg"
}

{
  // text and image message
  "action": "send",
  "status": "error",
  "code": 337,
  "message": "Error sending message.",
  "messages": [
    {
      "recipientId": "727063370635",
      "messageId": "aWdfZAG1faXRlbT",
      "message": "What a great day"
    },
    {
      "action": "messages",
      "status": "error",
      "code": 365,
      "message": "An error occurred sending the message attachment. Please verify the attachment is still available and try again."
    }
  ]
}