Sendblue for Node.js
Overview
"sendblue-ts" is a Typescript-friendly Node.js wrapper for the Sendblue API, providing a seamless interface for sending and receiving messages.
Prerequisites
Before using this library, you need to get your API keys from Sendblue by signing up for an account here.
Installation
Install the sendblue-ts package using your favourite package manager:
pnpm add @rileybarabash/sendblue-tsUsage
Initialization
Initialize a new Sendblue instance with your API keys. You can do so in separate file and import it as a module, or directly in your code.
import { env } from "process"
import Sendblue from "@rileybarabash/sendblue-ts"
/**
* Initialize a Sendblue instance.
*/
export const sendblue: Sendblue = new Sendblue(env.SENDBLUE_PK ?? "", env.SENDBLUE_SK ?? "")Send Message
Sends a message to a single recipient.
const response: SendMessageResponse = await sendblue.sendMessage({
number: "+19998887777",
content: "Hello from Sendblue!",
sendStyle: "invisible",
mediaUrl: "https://source.unsplash.com/random.png",
statusCallback: "https://example.com/callback"
})Send Group Message
Sends a message to a group of recipients.
const response: SendblueAPIResponse = await sendblue.sendGroupMessage({
numbers: ["+19998887777", "+19998887778"],
content: "Hello from Sendblue!",
sendStyle: "invisible",
mediaUrl: "https://source.unsplash.com/random.png",
statusCallback: "https://example.com/callback"
})Get Message
Gets the message associated with the provided ID.
const response: SendblueAPIResponse = await sendblue.getMessage({ id: "messageId" })Modify Group
Modifies a message group. Currently only supports adding recipients.
const response: SendblueAPIResponse = await sendblue.modifyGroup({
groupId: "groupId",
modifyType: "add_recipient",
number: "+19998887777"
})Lookup Number
Checks if a number is registered with iMessage.
const response: SendblueAPIResponse = await sendblue.lookup({ number: "+19998887777" })Send Typing Indicator
Sends a typing indicator to the specified recipient.
const response: SendblueAPIResponse = await sendblue.sendTypingIndicator({ number: "+19998887777" })Get Contacts
Retrieves a list of contacts associated with the Sendblue account.
const response: SendblueAPIResponse = await sendblue.getContacts()Create Contact
Creates a contact from a recipient's contact details.
const response: SendblueAPIResponse = await sendblue.createContact({
number: "+19998887777",
firstName: "First Name",
lastName: "Last Name",
companyName: "Company Name"
})Delete Contact
Deletes a contact with the specified ID.
const response: SendblueAPIResponse = await sendblue.deleteContact({ id: "contactId" })Get Messages
Gets all of the messages associated with a contact.
const response: SendblueAPIResponse = await sendblue.getMessages({ contactId: "contactId" })For more details and options, refer to the Sendblue API Documentation.
Made with <3 in YEG <Edmonton, Alberta>