Message Status

GET

https://rest.qikberry.ai/v1/sms/status

This endpoint makes an HTTP GET request to retrieve the status of a specific SMS message using its message id.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://rest.qikberry.ai/v1/sms/status?message_ids=3157693c-xxxx-xxxx-xxxx-5a2f600fxxxx:1' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json'

Response Example

200 - Success

{
    "message": "Retrieved Message details successfully",
    "data": [
        {
            "message_id": "3157693c-xxxx-xxxx-xxxx-5a2f600fxxxx:1",
            "isoCode": "IN",
            "phone": "+918080808080",
            "service": "SI",
            "message": "Dear {{1}} Thank you for your confirmation to pay Rs. {{2}} overdue against your YES BANK {{3}}. Visit {{4}} to pay.",
            "sender": "YESBNK",
            "template_id": "110716666831649xxxx",
            "flash": "0",
            "unicode": "0",
            "custom": "test",
            "custom1": "test",
            "custom2": "test",
            "length": 132,
            "units": 1,
            "charges": 0.21,
            "source": "api",
            "status": "DELIVERED",
            "submit_time": "2024-10-18T16:47:23+05:30",
            "submit_at": 1729250243,
            "deliv_time": "2024-10-18T16:47:24+05:30",
            "deliv_at": 1729250244
        }
    ],
    "page": 1,
    "length": 1
}

Request

Query Params

message_ids

string

required

Example:

3157693c-xxxx-xxxx-xxxx-5a2f600fxxxx:1

Header Params

Authorization

string

required

Pass access token

Example:

Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Content-Type

string

required

Example:

application/json

Responses

🟢200Success

application/json

Body

message

string

required

data

array [object {21}]

required

message_id

string

optional

isoCode

string

optional

phone

string

optional

service

string

optional

message

string

optional

sender

string

optional

template_id

string

optional

flash

string

optional

unicode

string

optional

custom

string

optional

custom1

string

optional

custom2

string

optional

length

integer

optional

units

integer

optional

charges

number

optional

source

string

optional

status

string

optional

submit_time

string

optional

submit_at

integer

optional

deliv_time

string

optional

deliv_at

integer

optional

page

integer

required

length

integer

required

🟠401Unauthorized

Send Batch Messages