Send an SMS

Send a text message to a phone number. The from number must be a phone number belonging to your company. Permission: sms:send

POST /api/sms/send

Send an SMS

cURL

curl --request POST \
  --url https://api.recepta.ai/api/v1/api/sms/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "to": "[phone]",
  "from": "[phone]",
  "body": "Hi! Your appointment is confirmed for tomorrow at 2pm."
}
'

import requests

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

payload = {
    "to": "[phone]",
    "from": "[phone]",
    "body": "Hi! Your appointment is confirmed for tomorrow at 2pm."
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    to: '[phone]',
    from: '[phone]',
    body: JSON.stringify('Hi! Your appointment is confirmed for tomorrow at 2pm.')
  })
};

fetch('https://api.recepta.ai/api/v1/api/sms/send', 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/send",
  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([
    'to' => '[phone]',
    'from' => '[phone]',
    'body' => 'Hi! Your appointment is confirmed for tomorrow at 2pm.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"to\": \"[phone]\",\n  \"from\": \"[phone]\",\n  \"body\": \"Hi! Your appointment is confirmed for tomorrow at 2pm.\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.recepta.ai/api/v1/api/sms/send")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"[phone]\",\n  \"from\": \"[phone]\",\n  \"body\": \"Hi! Your appointment is confirmed for tomorrow at 2pm.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"to\": \"[phone]\",\n  \"from\": \"[phone]\",\n  \"body\": \"Hi! Your appointment is confirmed for tomorrow at 2pm.\"\n}"

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

201

{
  "success": true,
  "message": "SMS sent successfully",
  "data": {
    "messageId": "69ab1d127e930a2684f4edb2",
    "conversationId": "69a5f5d966e89fbafd5c601f",
    "twilioSid": "SMf7704c3df4a56bfca5f2b5b9b4b74012",
    "status": "queued"
  }
}

{
  "success": false,
  "message": "Error description"
}

Authorizations

x-api-key · string · header · required

Your Recepta API key (starts with rcp_)

Body

application/json

to · string · required

Recipient phone number (E.164)

Example:

"[phone]"

from · string · required

Your Recepta phone number

Example:

"[phone]"

body · string · required

Message content

Example:

"Hi! Your appointment is confirmed for tomorrow at 2pm."

Response

201

application/json

SMS sent successfully

success · boolean

Example:

true

message · string

Example:

"SMS sent successfully"

data · object

Show child attributes