This document is structured for both business users and engineers that could work with LaunchSMS. Please contact us at support@launchsms.com with any questions.
Introduction
The LaunchSMS documentation is based on the Representational State Transfer (RESTful) architectural style. We want to easily be able to transfer data back and forth between our application and yours, therefore we have four design principles:
Use HTTP methods explicitly. Be stateless. Expose directory structure-like URIs.Transfer JavaScript Object Notation (JSON).
The LaunchSMS API is accessible via the following URL:https://go.launchsms.com/api/{entityType}/{endPoint}
Definitions
entityType – The “entityType” denotes the type of entities being accessed. The “entityType” could be users, messages, or reviews.
endPoint – The “endPoint” is the optional identifier of the entity being accessed.
Use Cases
We have documented the most typical use cases where a third party can integrate with LaunchSMS along the communication and review management process. There are many more opportunities where a partner can work with LaunchSMS’s APIs. Please contact us at support@launchsms.com to discuss potential opportunities.
Sending Messages
Background: A major process in LaunchSMS is allowing an end-user to send a message to the company and have that company agent communicate back and forth with the end-user using SMS. LaunchSMS pulls in relevant contact information (phone number, name, message, etc.) and then the agent can communicate back and forth with the end-user using SMS. A third party can provide different communication services so the end-user looking to communicate with the company can find it via a third party and communicate through the third party portals.
Sending Review Requests
Background: There are multiple customer retention opportunities after a service is completed by a company and a third party integrating with LaunchSMS can enhance this process. When a company completes a service, potential LaunchSMS partners could receive information that can help with understanding how the service went from the customer’s perspective or help with marketing. For example, once the service is completed, a survey could be sent to the customer to understand the job satisfaction.
Job Completion Triggers Survey to Customer Use Case: Customer satisfaction is an integral part of any company to receive repeat business in the future. These businesses want to make sure that their customers are happy with the jobs and will continue to do business with them. An easy way to understand if a customer was satisfied is by sending them a survey after job completion.
API OVERVIEW
What is an API? An Application Programming Interface (API) is a set of routines, protocols, and tools for building software applications. An API allows one software application to talk with another software application securely over the Internet. A software company releases its API to the public so that other software developers can design products that are powered by its service. A good API makes it easier to develop a program by providing all the building blocks. A programmer then puts the blocks together.
These are examples of the typical APIs utilized for LaunchSMS.
- Sending Messages – A major process in LaunchSMS is allowing an end-user to send a message to the company and have that company agent communicate back and forth with the end-user using SMS. LaunchSMS pulls in relevant contact information (phone number, name, message, etc.) and then the agent can communicate back and forth with the end-user using SMS. A third party can provide different communication services so the end-user looking to communicate with the company can find it via a third party and communicate through the third party portals.
- Sending Review Requests – There are multiple customer retention opportunities after a service is completed by a company and a third party integrating with LaunchSMS can enhance this process. When a company completes a service, potential LaunchSMS partners could receive information that can help with understanding how the service went from the customer’s perspective or help with marketing. For example, once the service is completed, a survey could be sent to the customer to understand the job satisfaction.
The API Operations section describes the operations performed by LaunchSMS and the ability to GET, POST, and PUT information via APIs.