Mobile Text Alerts Blog

SMS API for Mobile Text Alerts!

Looking for an SMS API to send out text messages?

Your account at Mobile-Text-Alerts.com comes with free SMS API access for developers to send out texts.

Below is what documentation for our SMS API looks like.

Try a free test account today to get a feel for how it works!

sms api

SMS API Documentation

send_message

Request

Response

send_mms_message

Request

Response

send_tts_message

Request

Response

add_member

Request

Response

delete_member

Request

Response

add_group

Request

Response

remove_group

Request

Response

list_groups

Request

Response

add_to_group

Request

Response

list_members

Request

Response

list_group_members

Request

Response

get_member

Request

Response

export replies

remove_from_group

Request

Response

lulacash

Request

Response

send_message

Send a text message to an individual, groups, or all of your subscribers.

Request

Parameter

Type

Sample

Required

number

string

5317398280 or john.doe@mobile-text-alerts.com

TRUE (if group_id is blank)

group_id

Int or “all”

123456789 or all

TRUE (if number is blank)

message

string

Hello, welcome to my text alerts

TRUE

from_email

string

me@my-company.com

FALSE

from_name

string

me

FALSE

Response

Parameter

Type

Sample

success

string

Message Sent

error

string

You do not have any texts remaining this month.


send_mms_message

Send an MMS message to an individual, groups, or all of your subscribers.

Request

Parameter

Type

Sample

Required

number

string

5317398280 or john.doe@mobile-text-alerts.com

TRUE (if group_id is blank)

group_id

Int or “all”

123456789 or all

TRUE (if number is blank)

message

string

Hello, welcome to my text alerts

TRUE

attachment

string

https://mobile-text-alerts.com/new_design/images/logomobile.png

FALSE

from_email

string

me@my-company.com

FALSE

from_name

string

me

FALSE

Response

Parameter

Type

Sample

success

string

Message Sent

error

string

You do not have any texts remaining this month.


send_tts_message

Send a text-to-speech message to an individual number, a group, or all your contacts.

Request

Parameter

Type

Sample

Required

number

int

5317398280

TRUE (if group_id is blank)

group_id

Int or “all”

123456789 or all

TRUE (if number is blank)

message

string

Hello, welcome to my text alerts

TRUE

Response

Parameter

Type

Sample

success

string

Message successfully sent to 1 recipient

failed_numbers

string

[“4317398281″,”5317398280”]


add_member

Add a subscriber to your text alert system.

Request

Parameter

Type

Sample

Required

number

int

5317398280

TRUE (if email is blank)

first_name

string

John

FALSE

last_name

string

Doe

FALSE

email

string

john.doe@gmail.com

TRUE (if number is blank)

groups

JSON object of group IDs

[‘123’, ‘124’, ‘125’]

FALSE

Response

Parameter

Type

Sample

success

string

Member Added

group

string

Joined group 123

error

string

Required field not set.


delete_member

Remove a subscriber from your account.

Request

Parameter

Type

Sample

Required

number

string

5317398280 or jane.doe@gmail.com

TRUE

Response

Parameter

Type

Sample

success

string

Member Deleted

error

string

Required field not set.


add_group

Add a group to your account.

Request

Parameter

Type

Sample

Required

name

string

My Group

TRUE

keyword

string

my_group

TRUE

Response

Parameter

Type

Sample

success

string

The group, My Group has been successfully added.

error

string

‘Keyword’ is required to add a group.


remove_group

Remove a group from your account.

Request

Parameter

Type

Sample

Required

id

int

1234567

TRUE (if keyword is blank)

keyword

string

my_group

TRUE (if id is blank)

Response

Parameter

Type

Sample

success

string

The group has been successfully removed.

error

string

The group could not be found


list_groups

Retrieve all groups on your account.

Request

No parameters required.

Response

Parameter

Type

Sample

body

JSON object

[{“id”:”1″,”name”:”Jane’s Group”,”hidden”:””}]


add_to_group

Add a member to a group.

Request

Parameter

Type

Sample

Required

number

string

5317398280 or jane.doe@gmail.com

TRUE

group_id

int

123

TRUE (if group_name is blank)

group_name

string

Jane’s Group

TRUE (if group_id is blank)

Response

Parameter

Type

Sample

success

boolean

TRUE or FALSE

error

string

Required field not set.


list_members

Retrieve all members for a specific account

Request

No parameters required.

Response

Parameter

Type

Sample

members

string

[{“firstName”:”John”,”lastName”:”Doe”,”number”:”5317398280″,”email”:”contact@mobile-text-alerts.com”}]


list_group_members

Retrieve all members for a specific group belonging to the account

Request

Parameter

Type

Sample

Required

group_id

int

1234567

TRUE

Response

Parameter

Type

Sample

members

JSON object

[{“firstName”:”John”,”lastName”:”Doe”,”number”:”5317398280″,”email”:”contact@mobile-text-alerts.com”}]


get_member

Retrieve all members for a specific account

Request

Parameter

Type

Sample

Required

number

string

5317398280

TRUE

Response

Parameter

Type

Sample

info

JSON object

{“firstName”:”John”,”lastName”:”Doe”,”number”:”5317398280″,”email”:”contact@mobile-text-alerts.com”,”groups”:[“123″,”456”]}

error

string

Could not find number on your account


export replies

Retrieves a JSON encoded list of all replies sent to your account.


remove_from_group

Remove a subscriber from a group

Request

Parameter

Type

Sample

Required

group_id

int

1234567

TRUE

number

string

5317398280 or john.doe@gmail.com or all

TRUE

Response

Parameter

Type

Sample

success

boolean

TRUE or FALSE

error

string

Required field not set.


lulacash

Create a new LuLaCash record for a specific subscriber

Request

Parameter

Type

Sample

Required

number

int

1112223333

TRUE (if email is blank)

email

string

contact@mobile-text-alerts.com

TRUE (if number is blank)

expires

date

1/1/2018

FALSE: defaults to +1 year

value

decimal

50.25

TRUE

Response

Parameter

Type

Sample

success

string

The record has been added and the subscriber has been notified

code

string

abc123e

Please follow and like us:
9

Add comment

Archives