Send SMS

You can use send sms API to send SMS message.

Request parameters

Name	Type	Required/Optional	Description
senderId	string	Required	Sender ID
templateId	string	Required	SMS template
message	string	Required	Text message
phoneNumber	string	Required	customer phone number

Request Information

Category	Value
Http request	POST
URL	https://bikapi.bikayi.app/integrations/bikPlatformFunctions-messages/v2/sendSms

curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-messages/v2/sendSms' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic AUTH_TOKEN' \
--data '{
    "senderId": "123456",
    "templateId": "Test Template ID",
    "message": "This is a test message",
    "phoneNumber": "+919900990090"
}'

JSON response example:

{
  "status": 200,
  "success": true,
  "data": {
    "messageId": "message_id1"
  }
}

Response parameters

Name	Type	Description
status	number	Response status
success	boolean	Is successful response or not
messageId	string	Message id if any

Errors

Error Code	Meaning
400	Invalid payload -- Your request is invalid.
401	Unauthorized -- User is not authenticated.
404	Not Found -- The specified API could not be found.
500	Internal Server Error -- We had a problem with our server. Try again later.

Error response example:

{
  "status": 400,
  "errors": [
    {
      "code": 400,
      "message": "Not able to send sms"
    }
  ]
}