Sms

Umeskia softwatres portal Sms offers you an api endpoint that you can quickly pluck your wonderful existing system into our bulk sms platform and seamlessly send bulk sms to your clients with less hustle.

SEND SMS

Method	Endpoint
POST	https://api.umeskiasoftwares.com/api/v1/sms

Headers:

Header	Description	value
Content-Type	The Accept request HTTP header advertises which content types, expressed as MIME types, the client can understand.	application/json


                                  "Content-Type : application/json"

Parameters:

Parameter	Description	Sample value
api_key	API key obtained from your UMS Portal	VE5MTlkzRk06MTlwNjlkZWM=
email	Email that you use to login into UMS Portal	example@example.com
Sender_Id	Use an active sender id if dont have you can use a default sender id of UMS_SMS	company_name or UMS_SMS(default)
message	Write the message you want to send here	Welcome to my company
phone	add the phone number that you are going to send the message to.	0768XXXX090


                                  {
                                    "api_key":"VE5MTlkzRk06MTlwNjlkZWM=",
                                    "email":"example@gmail.com",
                                    "Sender_Id": "UMS_SMS",
                                    "message": "UMS SMS Api Test Message",
                                    "phone":"0798765432"
                                  }

Response:


                                    {
                                        "success": "200",
                                        "massage": "Message sent sucessfully.",
                                        "request_id": "8403414672158573510"
                                    }

SMS CREDIT BALANCE

Method	Endpoint
POST	https://api.umeskiasoftwares.com/api/v1/smsbalance

Headers:

Header	Description	value
Content-Type	The Accept request HTTP header advertises which content types, expressed as MIME types, the client can understand.	application/json


                                  "Content-Type : application/json"

Parameters:

Parameter	Description	Sample value
api_key	API key obtained from your UMS Portal	VE5MTlkzRk06MTlwNjlkZWM=
email	Email that you use to login into UMS Portal	example@example.com


                                  {
                                    "api_key":"VE5MTlkzRk06MTlwNjlkZWM=",
                                    "email":"example@gmail.com",
                                  }

Response:


                                    {
                                        "success": "200",
                                        "creditBalance": 100,
                                    }

SMS DELIVERY REPORT

Method	Endpoint
POST	https://api.umeskiasoftwares.com/api/v1/smsdelivery

Headers:

Header	Description	value
Content-Type	The Accept request HTTP header advertises which content types, expressed as MIME types, the client can understand.	application/json


                                  "Content-Type : application/json"

Parameters:

Parameter	Description	Sample value
api_key	API key obtained from your Umeskia Softwares Portal (USP)	VE5MTlkzRk06MTlwNjlkZWM=
email	Email that you use to login into Umeskia Software Portal (USP)	example@gmail.com
request_id	You get the request_id id after every sms is successfully	8403414672158573510


                                    {
                                        "api_key":"VE5MTlkzRk06MTlwNjlkZWM=",
                                        "email":"example@gmail.com",
                                        "request_id" : "8403414672158573510"
                                      }

Response:


                                  {
                                      "ResultCode": "200",
                                      "request_id": "8403414672158573510",
                                      "submitted_time": "2024-01-26 11:30:40",
                                      "send_time": "2024-01-26 11:30:40",
                                      "sender_id": "UMS_SMS",
                                      "recepient": "0798765432",
                                      "sms_unit": 1,
                                      "sms_length": 150,
                                      "sms_type": "text",
                                      "message":"Welcome to my company STOP *456*9*5#",
                                      "status": "Pending"
                                  }