Qikberry API Docs
SMSRCS Business Messaging
SMSRCS Business Messaging
Qikberry.AI
App
  1. Messages
  • Senders
    • Get Sender
      GET
    • Add Sender
      POST
    • Update Sender
      PATCH
  • Templates
    • Get Templates
      GET
    • Add Template
      POST
    • Update Template
      PATCH
  • Messages
    • Send Message
      POST
    • Send Batch Messages
      POST
    • Message Status
      GET
  1. Messages

Send Message

POST
https://rest.qikberry.ai/v1/sms/messages
This endpoint enables to send a message to a specific number using an existing sender ID and template ID through an HTTP POST request.
Send message to multiple numbers
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://rest.qikberry.ai/v1/sms/messages' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": "+918072xxxxxx",
    "sender": "YESBNK",
    "service": "SI",
    "template_id": "120716993437302xxxx",
    "message": "Your one time password - OTP is {{1}} to sign in to your account"
}'
Response Response Example
200 - Success
{
    "message": "1 numbers accepted for delivery",
    "data": [
        {
            "message_id": "a1bd1b4d-xxxx-xxxx-xxxx-d21ed5d3xxxx:1",
            "mobile": "+918072xxxxxx",
            "message": "Your one time password - OTP is {{1}} to sign in to your account - Team Celebrare"
        }
    ]
}

Request

Header Params
Authorization
string 
required
Example:
Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type
string 
required
Example:
application/json
Body Params application/json
to
string 
required
Please enter mobile number after + and only numbers are allowed
sender
string 
required
Length must be 4 or 6, Only alphabets and numbers are allowed.
service
string 
required
Pass service code. Allowed values: T, P, SI (service implicit), SE (service explicit)
message
string 
required
Maximum 4000 characters are allowed
template_id
string 
required
Only numbers are allowed
custom
string 
optional
Pass reference id
Example:
test
custom1
string 
optional
Pass reference id
Example:
test1
custom2
string 
optional
Pass reference id
Example:
test2
flash
string 
optional
Accepted 0 or 1 in string literal
Examples:
01
time
string 
optional
Expected time value in ISO like 2024-12-12T12:58:00+05:30
Example:
2024-10-17T17:00:00+05:30
webhook_id
string 
optional
Webhook id available in Developer section
Example:
aff309cb-xxxx-xxxx-xxxx-e28e7c3xxxx
Examples

Responses

🟢200Success
application/json
Body
message
string 
required
data
array [object {3}] 
required
message_id
string 
required
mobile
string 
required
message
string 
required
🟠400Validation errors
Previous
Update Template
Next
Send Batch Messages
Built with