Send Outbound SMS

Back to API List

Send Outbound SMS API

This API enables sending outbound SMS messages through the platform’s generic SMS channel. The capability can be integrated into applications or services to facilitate SMS communication with customers.

Prerequisites

• The SMS channel must be configured to send outbound SMS using this API. Learn more.
• The phone number must be attached to an experience flow. Learn more.

Method	POST
Endpoint	https://{{host}}/api/public/bot/{{BotId}}/outboundsms
Content-Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token.
API Scope	Outbound SMS

Path Parameters

Parameter	Description	Type
host	Environment URL, for example, https://platform.kore.ai	string, required
BotId	BotId or StreamId. You can access it from the bot’s App Settings page.	string, required

Sample Request

curl --location 'https://{{host}}/api/public/bot/st-26d52ba6-7a77-56b2-be4e-a8db1da7e440/outboundsms' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'auth: <token>' \
--data '{
    "fromNo": "[phone]",
    "toNo": "[phone]"
}'

Body Parameters

Parameter	Description	Type
fromNo	The sender’s phone number in E.164 format. For example, [phone]. Note: This number must be attached to an Experience Flow.	string, required
toNo	The recipient’s phone number in E.164 format. For example, [phone]	string, required

Sample Response

{
    "message": "Triggered the configured Experience flow to deliver message via SMS channel"
}