Quick Start

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can get an API key from your Settings.

QIKCHAT API KEY

Make your first request

To make your first request, send an authenticated request to the messages endpoint. This will send a text message to the user.

Send a text message

POST https://api.qikchat.in/v1/messages

To send a message, use the request URL and the following body parameters.

Request Example

{

"to_contact": "8080808080",

"type": "text",

"text": {

"body": "Hey There!"

}

}

Headers

Name	Type	Description
QIKCHAT-API-KEY*	string	place API key

Request Body

Name	Type	Description
to_contact*	string	customer whatsapp number you want to send message
type*	string	text
text*	object	contains body field

200: OK

A successful response includes a data object with an ID for the message sent.

{
    "status": true,
    "message": "Messages queued successfully",
    "data": [
        {
            "id": "52JH6WmuSruAVyXvBBYemd0Ia",
            "channel": "whatsapp",
            "from": "919099999916",
            "recipient": "918080808080",
            "credits": 0.80,
            "created_at": "2023-02-19T12:52:25.222Z",
            "status": "queued"
        }
    ]
}