Skip to main content
GET
/
api
/
sms
List SMS conversations
curl --request GET \
  --url https://api.recepta.ai/api/v1/api/sms \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.recepta.ai/api/v1/api/sms"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.recepta.ai/api/v1/api/sms', 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.recepta.ai/api/v1/api/sms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.recepta.ai/api/v1/api/sms"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	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.recepta.ai/api/v1/api/sms")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.recepta.ai/api/v1/api/sms")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "SMS conversations retrieved successfully",
  "data": {
    "conversations": [
      {
        "id": "69a5f5d966e89fbafd5c601f",
        "customerPhone": "+12243000999",
        "companyPhone": "+17622528168",
        "customerName": "John Smith",
        "customerEmail": "<string>",
        "status": "ACTIVE",
        "lastMessageAt": "2023-11-07T05:31:56Z",
        "lastMessagePreview": "Thanks for the update!",
        "messageCount": 17,
        "unreadCount": 0
      }
    ],
    "pagination": {
      "total": 142,
      "page": 1,
      "limit": 20,
      "totalPages": 8
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Your Recepta API key (starts with rcp_)

Query Parameters

​
page
integer
default:1

Page number

​
limit
integer
default:50

Results per page

​
search
string

Search by phone or customer name

​
status
enum<string>

Filter by conversation status

Available options:
ACTIVE,
ARCHIVED,
CLOSED

Response

200 - application/json

Conversations retrieved

​
success
boolean
Example:

true

​
message
string
Example:

"SMS conversations retrieved successfully"

​
data
object