Communication

Sms alert

Learn how to use Sms alert with Composio

Overview

SLUG: SMS_ALERT

Description

SMS Alert is a versatile multi-channel communication platform enabling businesses to engage with customers through SMS, RCS, Telegram, and WhatsApp via a unified REST API.

Authentication Details

generic_api_key
stringRequired

Connecting to Sms alert

Create an auth config

Use the dashboard to create an auth config for the Sms alert toolkit. This allows you to connect multiple Sms alert accounts to Composio for agents to use.

1

Select App

Navigate to [Sms alert](https://platform.composio.dev?next_page=/marketplace/Sms alert).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Sms alert Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4sms_alert_auth_config_id = "ac_YOUR_SMS_ALERT_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Sms alert for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, sms_alert_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Sms alert toolkit’s playground](https://app.composio.dev/app/Sms alert)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["SMS_ALERT"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get SMS Alert Balance

Description

Tool to retrieve the current sms credit balance. use when you need an up-to-date credit status before sending messages.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group Detail

Description

Tool to retrieve details of a specific sms alert group. use after confirming the group id.

Action Parameters

group_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group List

Description

Tool to retrieve a list of sms alert groups. use when you need to fetch all groups associated with your account. call after authenticating your api key.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Sender ID List

Description

Tool to fetch the list of available sender ids. use when you need to retrieve all sender ids associated with your account. use after configuring your api key.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Template List

Description

Tool to retrieve list of sms templates from your smsalert account. use when you need to display or manage your smsalert templates.

Action Parameters

template_type
string

Action Response

data
arrayRequired
error
string
message
string
status
stringRequired
successful
booleanRequired

Tool Name: Create New Contact

Description

Create new contact

Action Parameters

group
stringRequired
mobile
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create New Group

Description

Tool to create a new contact group. use when needing to organize contacts into a new group.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Short URL

Description

Tool to create a short url for a given long url. use when you need to shorten a url before sharing.

Action Parameters

alias
string
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create SMS Template

Description

Tool to create a new sms template. use when you need to define reusable message content.

Action Parameters

name
stringRequired
text
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Contact

Description

Tool to delete a specified contact. use after confirming the contact's id.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Group

Description

Tool to delete a specified group. use after confirming the group's id.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Short URL

Description

Tool to delete an existing short url. use after confirming the short url's id.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete SMS Template

Description

Tool to delete an existing sms template. use when you have the template id to remove it.

Action Parameters

template_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit Contact

Description

Tool to edit an existing contact’s details. use when you need to update a contact’s information after confirming the contact id.

Action Parameters

contact_id
stringRequired
email
string
group_id
string
mobileno
string
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit Group

Description

Tool to edit an existing groups name. use when you need to rename a group after confirming the group id.

Action Parameters

id
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update User Profile

Description

Tool to update user account profile details. use when modifying authenticated user profile after login.

Action Parameters

address
string
city
string
company
string
country
string
email
string
gst
string
mobileno
stringRequired
pincode
string
state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit SMS Template

Description

Tool to edit an existing sms template. use when you need to update a template after confirming the template id.

Action Parameters

id
stringRequired
name
stringRequired
text
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Generate OTP

Description

Tool to generate a one-time password (otp). use when you need to send an otp to a mobile number using a predefined template.

Action Parameters

mobileno
stringRequired
sender
string
template
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Sent SMS Report

Description

Tool to retrieve sms campaign sent report details. use after campaigns are sent to analyze delivery results.

Action Parameters

campaignuniqueid
string
limit
integerDefaults to 20
mobile
string
page
integerDefaults to 1

Action Response

data
arrayRequired
error
string
limit
integerRequired
message
stringRequired
page
integerRequired
status
stringRequired
successful
booleanRequired
total_records
integerRequired