Method addCredits to Add Credits to a Group
This provides the capability to via api to add credits to a group.
https://primary.smartmessagingservices.net/gateway/services/SMSService?method=getBalance &username=admin.username&password=youradmin.password&groupname=your.customersgroupname&credits=amountofcreditstoadd
*Please note that when using the HTTP Get method you must url encode any special characters
original character |
url encoded |
|---|---|
(space) |
+ |
+ |
%2B |
A documentId is returned which can then be used to query the status of the submitted SMS.
method |
parameters |
return |
|---|---|---|
addCredits |
(String username, String password, String groupName, int credits); |
int creditsAdded, int statusCode, string groupName |
Attributes |
Description |
|---|---|
credits |
can only be a position whole number |
groupName |
must be a subgroup of the group belonging to the username and password - is case sensitive and must be an exact match |
Error Codes Returned
Error |
Code |
Description |
|---|---|---|
ERR_INVUSERNAME |
-101 |
When no username is passed in |
ERR_INVPASSWD |
-102 |
When no password is passed in |
ERR_INVXML |
110 |
incoming XML document format incorrect |
ERR_INVAAA |
-200 |
Incorrect username/password |
ERR_NOGROUP |
-203 |
Group Name does not exist |
ERR_ACTINACTIVE |
-201 |
username inactive |
ERR_INVSERVICE |
-211 |
requested service not supported for this account |
ERR_NOSERVICE |
-900 |
service not available |
ERR_INTERNALERROR |
-999 |
Thrown when a error occurred for some generic reason when processing a request |