Follow

Stop Sending SMS to Subscriber

The Stop Sending SMS to Subscriber command allows you to unsubscribe an existing SMS subscriber from an SMS Sender Code. The command is used to remove Subscribers who no longer wish to receive SMS messages.  The command requires the following arguments: Command, Realm, Password, Phone Number, and Sender Code.

api_web?r=myrealm&p=mypass&c=smsstopsubscribersend&phone=12065551212&sender_code=120162701555

The command is ‘smsstopsubscribersend', the realm is ‘myrealm’ and the password is ‘mypass’.  The SMS subscriber with the matching phone number will be removed from the sender code '120162701555'.

Example

Using smsstopsubscribersend with all commands and arguments (please note the command is wrapped for display purposes only):

api_web?r=myrealm&p=mypass&c=smsstopsubscribersend&phone=12065551212&sender_code=120162701555

Successful results return:

SUCCESS: Stopping message to phone was successful

Results

The Stop Sending SMS to Subscriber command outputs either a SUCCESS or FAILURE message. 

Success

The command success message returns the SUCCESS message.  The result format is:

SUCCESS: Stopping message to phone was successful

Failure

The command will fail if a subscription does not exist, if the phone number is not found, or if an argument is invalid.  The result format is:

FAILURE: [Reason]  

Arguments

The command supports the following arguments:

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=smsstopsubscribersend

c=smsstopsubscribersend

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]

r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

Phone

Yes

Numeric phone number for the subscriber.  Do not include special characters (such as parenthesis or dash). 

phone=[phone]

Sender Code

Yes 

Sender Code representing the message sender.  A Sender Code is either a short code or number. It represents the 'from' field when deploying an SMS. The message recipient will see this sender on their mobile device when a message is received.

sender_code=[sender_code]

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk