SMS API Reference

Learn how to send SMS messages programmatically

Youssef Amir avatar
Written by Youssef Amir
Updated over a week ago

Through Octopods, you can use our SMS API to programmatically send SMS messages to your Users directly.

Authentication

Once your SMS channel is connected, we generate an API Key for your account to be used. You can retrieve your API Key directly from our Octopods App by selecting your channel.

API Endpoints

Send an SMS Message

The payload must be in JSON.
โ€‹
โ€‹Request (in cURL)

curl --location --request POST 'https://app.octopods.io/api/v1/sms/messages' \--header 'X-Octopods-Auth: YOUR_API_KEY' \--header 'Content-Type: application/json' \--data-raw '
{
"destination_phone": "+353838000000",
"body": "MESSAGE_BODY",
"open_intercom_conversation": false
}'

Parameter

Possible Values

Description

Required

destination_phone

any e164 valid phone

the destination phone to send a message template to

Yes

body

object

the body of the SMS message

Yes

open_intercom_conversation

true or false

if you want Octopods to create an Intercom conversation in your Inbox

No

Did this answer your question?