SOAP Access Service
The SOAP web service provides functionality for maintaining a contact book, sending single messages, and sending bulk messages. Users can create groups and store contacts in those groups, submit bulk messages, and receive delivery reports.
This web service can be integrated using the following WSDL link.
http://<ipaddress>:<port>/SOAPServices/Service?wsdlHow to consume the web service
The provided web service is of type JAX-WS. To consume this web service, create a standard Java application or web application and use the WSDL link above to create a Web Service Client.
Once the web service client has been configured properly, the methods present in the web service will be visible in the Web Service Reference. Use these methods for sending messages.
| Method Name | Description |
|---|---|
| addGroup | Adds a group into the system. |
| updateGroup | Updates an available group. |
| deleteGroup | Deletes a present group. |
| getGroup | Returns all the present groups for the given user. |
| getContact | Returns all the contacts present in the given group for the given user. |
| addContact | Adds a contact into the system. |
| updateContact | Updates a contact present in the given group. |
| deleteContact | Deletes contacts from the system. |
| sendBulkMessage | Sends bulk messages. |
| sendSingleMessage | Sends single messages. |
| getCreditDetails | Gives the balance of the given user account. |
| getSender | Used to give the allowed source for the given user. |
| sendGroupMessage | Used to send a message to all destinations present in the given group. |
| scheduleMessage | Used to schedule a message. |
| groupSchedule | Used to schedule a message for the destinations present in a group. |
| getDlr | Gets DLR information. |
| updateDlr | Updates DLR information. |
System Boundary
addGroup
This method adds a new group as per the name provided. If the group is already present for the user, then it won't get added.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | groupname | Group name to be added. |
| 3 | password | Password for the respective user. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | 1701 | Success, Group has been added successfully. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1710 | Unknown Error. |
| 5 | 1712 | Database Error. |
| 6 | 101 | Operation Failed. Because of some internal error, group addition operation failed. |
| 7 | 102 | Group Already Exists. Group name already present for the given user. |
updateGroup
This method updates the name of the present group with a new name provided. It first checks if the group to be updated is present or not, and if present it will check if there is any group with the same name as the new group name for the given user.
Request Parameters
| Sr. No. | Parameter Name | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | newname | New name for the group. |
| 4 | previousname | Current name of the group to be updated. |
Response
| Sr. No. | Error Codes | Description |
|---|---|---|
| 1 | 1701 | Success, Group has been updated successfully. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1710 | Unknown Error. |
| 5 | 1712 | Database Error. |
| 6 | 101 | Operation Failed. Because of some internal error, group updation operation failed. |
| 7 | 102 | Group Already Exists. Group name already present for the given user. |
| 8 | 103 | Group Not Found. Group to be updated not present. |
deleteGroup
This method deletes the provided group name for the given user. First it will be checked if the group is present for the given user or not.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | groupname | New name for the group. |
Response
| Sr. No. | Error Codes | Description |
|---|---|---|
| 1 | 1701 | Success, Group has been deleted successfully. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1710 | Unknown Error. |
| 5 | 1712 | Database Error. |
| 6 | 101 | Operation Failed. Because of some internal error, group deletion operation failed. |
| 7 | 103 | Group Not Found. Group to be deleted not present. |
getGroup
This method returns the list of present groups for the given user. In this case, if there is more than one group present for the user, then group names would be separated by |.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
Response
| Sr. No. | Error Code | Description | |
|---|---|---|---|
| 1 | - | In case of success, group names would be returned as response. For more than one group name, names would be separated by ` | `. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. | |
| 3 | 1703 | Bad Username Password. Means user authentication failed. | |
| 4 | 1710 | Unknown Error. | |
| 5 | 1712 | Database Error. | |
| 6 | 104 | No Record Found. No groups found for the given user. |
addContact
This method adds the given contact into the specified group for the provided user. It first checks if the provided group exists or not; if it does, then it will check if the given user name is present in the group for the given user or not, and then it will add the contact into the group.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | groupname | New name for the group. |
| 4 | contactname | Name of the contact to be added. |
| 5 | contactnumber | Contact number for the corresponding name to be added. |
Response
| Sr. No. | Error Codes | Description |
|---|---|---|
| 1 | 1701 | Success, Contact has been added successfully. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1706 | Bad Destination. Contact number given by the user is invalid. |
| 5 | 1710 | Unknown Error. |
| 6 | 1712 | Database Error. |
| 7 | 101 | Operation Failed. Because of some internal error, contact addition operation failed. |
| 8 | 103 | Group Not Found. Group into which contact has to be added not found for the given user. |
| 9 | 105 | Contact Exists. Contact name to be added already exists in the specified group for the given user. |
updateContact
This method updates the given contact information. The current name or number of any contact can be updated, provided the contact and the group are present for the user.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | groupname | New name for the group. |
| 4 | newname | Updated contact name. |
| 5 | newnumber | Updated contact number for the corresponding contact name. |
| 6 | oldname | Contact name which has to be updated. |
| 7 | oldnumber | Corresponding contact number which has to be updated. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | 1701 | Success, Contact has been updated successfully. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1706 | Bad Destination. Contact number given by the user is invalid. |
| 5 | 1710 | Unknown Error. |
| 6 | 1712 | Database Error. |
| 7 | 101 | Operation Failed. Because of some internal error, contact update operation failed. |
| 8 | 103 | Group Not Found. Group into which contact has to be updated not found for the given user. |
| 9 | 104 | No Record Found. Given contact name to be updated not found in the given group for the given user. |
| 10 | 105 | Contact Exists. Contact name to be updated already exists in the specified group for the given user. |
deleteContact
This method will delete the specified contact details from the given group for the provided user. It will first check if the contact is present or not and then will delete it.
Request Parameters
| Sr. No. | Parameter Name | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | groupname | New name for the group. |
| 4 | contacts | Contacts which have to be deleted. It is possible to delete more than one contact at a time; the user has to pass contactname,contactnumber|contactname,contactnumber|…… |
Response
| Sr. No. | Error Codes | Description |
|---|---|---|
| 1 | 1701 | Success, Contact has been deleted successfully. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1710 | Unknown Error. |
| 5 | 1712 | Database Error. |
| 6 | 103 | Group Not Found. Group from which contact has to be deleted not found for the given user. |
| 7 | 104 | No Record Found. Given contact name to be deleted not found in the given group for the given user. |
getContact
This method returns the contacts present in the given group for the specified user.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | groupname | New name for the group. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | - | In case of success, contacts would be returned as contactname,contactno|contactname,contactno|… |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1710 | Unknown Error. |
| 5 | 1712 | Database Error. |
| 6 | 103 | Group Not Found. Group from which contacts has to be retrieved not found. |
| 7 | 104 | No Record Found. No contacts found in the specified group. |
sendSingleMessage
This method sends a single message to the specified destination.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | sender | Source of the message. |
| 4 | destination | Destination to which message has to be sent. |
| 5 | message | Message content. |
| 6 | type | Type of the message. 0: Text 1: Flash 2: Unicode 6: Unicode Flash |
| 7 | url | Used when message type=4. In case of other types, it can be blank. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | - | In case of successful message sending, 1701|destination:messageid would be returned as response. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1704 | Bad Type. Specified type is invalid. Please check the type values given in the 'Request Parameters' table above. |
| 5 | 1705 | Bad Message. Message provided might be empty or null. |
| 6 | 1706 | Bad Destination. Destination number given by the user is invalid. |
| 7 | 1707 | Bad Source. Message source given is invalid. |
| 8 | 1710 | Unknown Error. |
| 9 | 1712 | Database Error. |
sendBulkMessage
This method is used to send bulk messages. More than one destination can be given at a time. The only requirement is that every destination has to be on a new line.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | sender | Source of the message. |
| 4 | destination | Destination to which message has to be sent. More than one destination has to be given on a new line. |
| 5 | message | Message content. |
| 6 | type | Type of the message. 0: Text 1: Flash 2: Unicode 6: Unicode Flash |
| 7 | url | Used when message type=4. In case of other types, it can be blank. |
Response
| Sr. No. | Error Codes | Description |
|---|---|---|
| 1 | 1701 | Success. Bulk message has been loaded successfully on the server. Will get processed in some time. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1704 | Bad Type. Specified type is invalid. Please check the type values given in the 'Request Parameters' table above. |
| 5 | 1710 | Unknown Error. |
| 6 | 1712 | Database Error. |
| 7 | 101 | Operation Failed. Bulk message sending operation failed for some internal reasons. |
getCreditDetails
This method returns the balance of the given user account.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | - | In case of success, balance of the account would be returned as response. |
| 2 | 1702 | Bad URL. Means one of the parameters is missing. |
| 3 | 1703 | Bad Username Password. Means user authentication failed. |
| 4 | 1710 | Unknown Error. |
| 5 | 1712 | Database Error. |
getSender
This method returns sender names for the respective username.
Request Parameters
| Sr. No. | Parameter | Description (Values should be URL Encoded) |
|---|---|---|
| 1 | username | Name of the user. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | - | In case of success, sender from database is returned. |
| 2 | BAD_URL | One of the parameters is missing. |
| 3 | NOT_EXISTS | No record found. No sender found for that particular username. |
| 4 | DB_ERROR | Database Error. |
| 5 | ERROR | Unknown Error. |
sendGroupMessage
This method is used to send a group message.
Request Parameters
| Sr. No. | Parameter | Description |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | message | Message to be sent. |
| 4 | type | Type of the message. 0: Text 1: Flash 2: Unicode 3: Binary 4: WAP 6: Unicode Flash |
| 5 | groupname | Name of group. |
| 6 | source | Source of message. |
| 7 | url | Used when message type=4. In case of other types, it can be blank. |
Response
| Sr. No. | Error Codes | Description |
|---|---|---|
| 1 | 1701 | Message sent successfully. |
| 2 | 1702 | One of the parameters is missing. |
| 3 | 1703 | Bad Username Password. This means user authentication failed. |
| 4 | 1704 | Message type is invalid. |
| 5 | 1705 | Invalid message. |
| 6 | 1706 | Invalid destination. |
| 7 | 1707 | Invalid sender. |
| 8 | 1710 | Unknown Error. |
| 9 | 1915 | Group name not present. |
| 10 | 1916 | Destination not available for given group name. |
scheduleMessage
This method is used to schedule a message.
Request Parameters
| Sr. No. | Parameter | Description (Values should be URL encoded) |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password of the respective user. |
| 3 | message | Message to be sent. |
| 4 | destination | Destination to which the message is to be sent. More than one destination needs to be separated by a comma (,). |
| 5 | type | Type of the message. 0: Text 1: Flash 2: Unicode 3: Binary 4: WAP 6: Unicode-Flash |
| 6 | source | Source of the message. |
| 7 | scheduledate | Scheduled date for the message. Date needs to be in the following format: MM/DD/YYYY MM: Examples of month: 01,12 DD: Examples of date: 01,18,30 YYYY: Example of year: 2013 Example of scheduledate: 03/03/2013 |
| 8 | scheduletime | Scheduled time for the message. Time needs to be in the following format: hh:mm am/pm hh: Hours range from 00 to 12 mm: Examples of minutes: 00, 15, 30 am/pm: one of (am) or (pm) Example of scheduletime: 03:45 am OR 11:51 pm |
| 9 | gmt | GMT +hh:mm OR GMT -hh:mm OR +hh:mm OR -hh:mm hh: Hours range from 0 to 12 mm: Examples of minutes: 00 or 30 Example: GMT +1:30 OR -10:00 |
| 10 | url | URL is used in case of type=4 messages. In other cases, it can be kept empty. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | 1701 | Message scheduled successfully. |
| 2 | 1702 | One of the parameters is missing. |
| 3 | 1703 | User authentication has failed. |
| 4 | 1704 | Invalid message type. |
| 5 | 1705 | Invalid message. |
| 6 | 1706 | Invalid destination. |
| 7 | 1707 | Invalid sender. |
| 8 | 1710 | Unknown error. |
| 9 | 1902 | Bad schedule date. |
| 10 | 1904 | Bad schedule time. |
| 11 | 1903 | Invalid GMT. |
| 12 | 1905 | Invalid date and time OR date and time is already past. |
groupSchedule
This method is used to schedule a group message.
Request Parameters
| Sr. No. | Parameter | Description (Values should be URL encoded) |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password of the respective user. |
| 3 | groupname | Name of group. |
| 4 | message | Message to be sent. |
| 5 | type | Type of the message. 0: Text 1: Flash 2: Unicode 3: Binary 4: WAP 6: Unicode-Flash |
| 6 | source | Source of the message. |
| 7 | scheduledate | Scheduled date for the message. Date needs to be in the following format: MM/DD/YYYY MM: Examples of month: 01,12 DD: Examples of date: 01,18,30 YYYY: Example of year: 2013 Example of scheduledate: 03/03/2013 |
| 8 | scheduletime | Scheduled time for the message. Time needs to be in the following format: hh:mm am/pm hh: Hours range from 00 to 12 mm: Examples of minutes: 00, 15, 30 am/pm: one of (am) or (pm) Example of scheduletime: 03:45 am OR 11:51 pm |
| 9 | gmt | GMT +hh:mm OR GMT -hh:mm OR +hh:mm OR -hh:mm hh: Hours range from 0 to 12 mm: Examples of minutes: 00 or 30 Example: GMT +1:30 OR -10:00 |
| 10 | url | URL is used in case of type=4 messages. In other cases, it can be kept empty. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | 1701 | Message scheduled successfully. |
| 2 | 1702 | One of the parameters is missing. |
| 3 | 1703 | User authentication has failed. |
| 4 | 1704 | Invalid message type. |
| 5 | 1705 | Invalid message. |
| 6 | 1707 | Invalid sender. |
| 7 | 1710 | Unknown error. |
| 8 | 1902 | Bad schedule date. |
| 9 | 1904 | Bad schedule time. |
| 10 | 1903 | Invalid GMT. |
| 11 | 1905 | Invalid date and time OR date and time is already past. |
| 12 | 1915 | Group name not present. |
| 13 | 1916 | Destination not available for given group name. |
getDlr
This method returns DLR information of a given messageid.
Request Parameters
| Sr. No. | Parameter | Description (Values should be URL encoded) |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | messageid | Message Id of the message whose DLR information is to be returned. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | - | In case of success, dlr info would be returned as sender|mobileno|status|dtSubmit|dtDone|costPerSms|charge|errorExpression; (one entry per line). |
| 2 | 1702 | Bad URL. This means one of the parameters is missing. |
| 3 | 1710 | Unknown Error. |
| 4 | 104 | No Record Found. No messageid found for particular username. |
updateDlr
This method deletes the record of the given messageid.
Request Parameters
| Sr. No. | Parameter | Description (Values should be URL encoded) |
|---|---|---|
| 1 | username | Name of the user. |
| 2 | password | Password for the respective user. |
| 3 | messageid | Message Id of the message whose record is to be deleted. |
Response
| Sr. No. | Error Code | Description |
|---|---|---|
| 1 | 1701 | In case of success, records are deleted. |
| 2 | 1702 | Bad URL. This means one of the parameters is missing. |
| 3 | 1710 | Unknown Error. |
| 4 | 104 | No Record Found. No messageid found for particular username. |
Error Codes
| Error Code | Description |
|---|---|
| 101 | Operation Failed. |
| 102 | Group Exists. |
| 103 | Group Not Found. |
| 104 | No Record Found. |
| 105 | Contact Exists. |
| 1701 | Success. |
| 1702 | Bad Type. |
| 1703 | Bad Username Password. |
| 1704 | Bad Type. |
| 1705 | Bad Message. |
| 1706 | Bad Destination. |
| 1707 | Bad Source. |
| 1710 | Unknown Error. |
| 1712 | Database Error. |
| 1901 | Bad Content Type. |
| 1902 | Bad Schedule Date. |
| 1903 | Bad GMT. |
| 1904 | Bad Schedule Time. |
| 1905 | Bad Schedule Timestamp. |
| 1913 | Too many requests. |
| 1914 | Invalid date. |
| 1915 | No Group available. |
| 1916 | No Contacts available. |
Updated 18 days ago
Did this page help you?