messaging

Send SMS to one or more recipients (E.164 format)

Send an SMS message to one or more phone numbers in E.164 format. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

POST/api/messaging/projects/{projectId}/messaging/sms

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYesProject ID (MongoDB ObjectId) for the messaging project.

Request Body

Recipient phone number(s), message body, and optional sender ID.

json
{
  "to": "port back up",
  "message": "Stylish Keyboard designed to make you stand out with lively looks",
  "from": "protocol connect"
}
{
  "to": "port back up",
  "message": "Stylish Keyboard designed to make you stand out with lively looks",
  "from": "protocol connect"
}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.messaging.sendSms({
  projectId: "proj_HAIoKtDXcfhK",
  to: "feed generate",
  message: "Stylish Tuna designed to make you stand out with shocked looks",
  from: "circuit parse"
});
const result = await client.messaging.sendSms({
  projectId: "proj_HAIoKtDXcfhK",
  to: "feed generate",
  message: "Stylish Tuna designed to make you stand out with shocked looks",
  from: "circuit parse"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Responses

201SMS sent
json
{
  "success": true,
  "data": {
    "_id": "65a1b2c3d4e5f6789012345f",
    "type": "sms",
    "to": "+1234567890",
    "status": "sent",
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}
{
  "success": true,
  "data": {
    "_id": "65a1b2c3d4e5f6789012345f",
    "type": "sms",
    "to": "+1234567890",
    "status": "sent",
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Errors

CodeMeaning
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Next steps

Edit this page on GitHub