Send an SMS | Saperly Docs

Sends an outbound SMS from the specified line. Requires that an inbound SMS was received from the destination number within the last 24 hours (conversation window compliance).

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Request

This endpoint expects an object.

line_idstringRequiredformat: "uuid"

ID of the line to send from

tostringRequired

Destination phone number in E.164 format

textstringRequired1-1600 characters

SMS message body

Response

SMS sent

idstring

Carrier message SID

line_idstringformat: "uuid"

tostring

Destination phone number (E.164)

textstring

Message body

statusstring

Carrier delivery status

created_atdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

1	const url = 'https://saperly.com/api/v1/messages';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"line_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","to":"+15551234567","text":"Hello! Your appointment is confirmed for tomorrow at 3 PM."}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": "SM1234567890abcdef",
3	"line_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4	"to": "+15551234567",
5	"text": "Hello! Your appointment is confirmed for tomorrow at 3 PM.",
6	"status": "delivered",
7	"created_at": "2024-01-15T09:30:00Z"
8	}