Message

You can use this API for managing various behaviour of message.

Send Message

After succeed creating chat room in Qiscus Server, now you can send message to the chat room. There are several type of message that you can post to a chat room, instead of text (default). Each message has different payload format (particularly in JSON/JSON string). You also you can build your own type using custom type in a message.

If you are using Qiscus Chat Multichannel, and need to post message as bot, you can find the base URL in this link.

You cannot using this BASE URL to send message to Multichannel, your message won't be passed to respective channels (WhatsApp, Facebook Messenger, Line Messenger, etc)

Request:

HTTP
    
 
https://api.qiscus.com/api/v2.1/rest/post_comment
Copy

Headers:

Bash
    
 
"Content-Type":"application/json""QISCUS-SDK-APP-ID":"Your Qiscus App Id""QISCUS-SDK-SECRET":"Your Qiscus SDK Secret Key"
Copy

Endpoint:

[POST] /post_comment

Params:

Key	Type	Description
user_id (required)	string	User id in Qiscus Server
room_id (required)	string	it can be room id or room unique id specified by client or auto generated by server
message (required)	string	Max message content is 4000 chars
type (optional)	string	default: text, and there are predefined that Qiscus provides [account_linking\|button_postback_response\|buttons\|card\|carousel\|contact_person\| custom\|file_attachment\|location\|reply\|text]
payload (optional)	json	payload for specified type
extras (optional)	json	Meta data in message

An example request of send a message with default type (text):

Bash
    
 
curl -X POST \  https://api.qiscus.com/api/v2.1/rest/post_comment \  -H 'Content-Type: application/json' \  -H 'QISCUS-SDK-APP-ID: sdksample' \  -H 'QISCUS-SDK-SECRET: 2820ae9dfc5362f7f3a10381fb89afc7' \  -d '{  "user_id": "guest@qiscus.com",  "room_id": "1375619",  "message": "this is new message"}'
Copy

And the response from above request will be:

JSON
    
​x
    
{​    "results": {        "comment": {            "message": "this is new message",            "payload": {},            "timestamp": "2019-11-03T14:45:33Z",            "type": "text",            "user": {                "avatar_url": "https://res.cloudinary.com/qiscus/image/upload/v1507272514/kiwari-prod_user_id_340/uvwlno1qkkgh9xwwjzgq.png",                "extras": {},                "user_id": "guest@qiscus.com",                "username": "Qiscus Demo"            }        }    },    "status": 200}
Copy

Message type's payload and response:

The predefined message type have its payload, you can see for each message type's payload below:

buttons type

Here's an example request payload:

JSON
    
 
{  "user_id": "guest@qiscus.com",  "room_id": "457",  "type": "buttons",  "payload": {    "text": "silahkan pencet",    "buttons": [        {            "label": "button1",            "type": "postback",            "payload": {                "url": "http://somewhere.com/button1",                "method": "get",                "payload": null            }        },        {            "label": "button2",            "type": "link",            "payload": {                "url": "http://somewhere.com/button2?id=123"            }        }    ]  }}
Copy

Response with button's payload example :

JSON
    
 
{  "results": {    "comment": {      "message": "",      "payload": {        "text": "Silahkan pilih menu berikut:",        "buttons": [            {                "label": "button1",                "type": "postback",                "payload": {                    "url": "http://somewhere.com/button1",                    "method": "get",                    "payload": null                }            },            {                "label": "button2",                "type": "link",                "payload": {                    "url": "http://somewhere.com/button2?id=123"                }            }        ]      },      "timestamp": "2018-03-12T08:11:37Z",      "type": "buttons",      "user": {        "avatar_url": "https://res.cloudinary.com/qiscus/image/fetch/http://myimage.com/image.jpg",        "user_id": "guest@qiscus.com",        "username": "Qiscus Demo"      }    }  },  "status": 200}
Copy

card type

Here's an example request payload:

JSON
    
 
{  "user_id": "guest@qiscus.com",  "room_id": "457",  "type": "card",  "payload": {    "text": "Special deal buat sista nih..",    "image": "http://url.com/gambar.jpg",    "title": "Atasan Blouse Tunik Wanita Baju Muslim Worie Longtop",    "description": "Oleh sippnshop\n96% (666 feedback)\nRp 49.000.00,-\nBUY 2 GET 1 FREE!!!",    "url": "http://url.com/baju?id=123&track_from_chat_room=123",    "buttons": [        {            "label": "button1",            "type": "postback",            "payload": {                "url": "http://somewhere.com/button1",                "method": "get",                "payload": null            }        },        {            "label": "button2",            "type": "link",            "payload": {                "url": "http://somewhere.com/button2?id=123",                "method": "get",                "payload": null            }        }    ]  }}
Copy

Response with card's payload example:

JSON
    
 
{  "results": {    "comment": {      "message": "Special deal buat sista nih..",      "payload": {        "buttons": [          {            "label": "button1",            "postback_text": "",            "type": "postback",            "payload": {              "url": "http://somewhere.com/button1",              "method": "get",              "payload": null            }          },          {            "label": "button2",            "postback_text": "",            "type": "link",            "payload": {              "url": "http://somewhere.com/button2?id=123",              "method": "get",              "payload": null            }          }        ],        "description": "Oleh sippnshop\n96% (666 feedback)\nRp 49.000.00,-\nBUY 2 GET 1 FREE!!!",        "image": "http://url.com/gambar.jpg",        "text": "Special deal buat sista nih..",        "title": "Atasan Blouse Tunik Wanita Baju Muslim Worie Longtop",        "url": "http://url.com/baju?id=123&track_from_chat_room=123"      },      "timestamp": "2018-03-12T08:11:47Z",      "type": "card",      "user": {        "avatar_url": "https://res.cloudinary.com/qiscus/image/fetch/http://myimage.com/image.jpg",        "user_id": "guest@qiscus.com",        "username": "Qiscus Demo"      }    }  },  "status": 200}
Copy

carousel type

Here's an example request payload:

JSON
    
 
{    "user_id": "guest@qiscus.com",    "room_id": "457",    "type" : "carousel",    "payload": {    "cards": [        {            "image": "http://url.com/gambar.jpg",            "title": "Atasan Blouse Tunik Wanita Baju Muslim Worie Longtop",            "description": "Oleh sippnshop\n96% (666 feedback)\nRp 49.000.00,-\nBUY 2 GET 1 FREE!!!",            "default_action": {                "type": "postback",                "postback_text": "Load more",                "payload": {                    "url": "http://url.com/baju?id=123&track_from_chat_room=123",                    "method": "get",                    "payload": null                }            },            "buttons": [                {                    "label": "button1",                    "type": "postback",                    "postback_text": "Load more",                    "payload": {                        "url": "http://somewhere.com/button1",                        "method": "get",                        "payload": null                    }                },                {                    "label": "button2",                    "type": "link",                    "payload": {                        "method": "get",                         "url": "http://somewhere.com/button2?id=123"                    }                }            ]        }    ]  }}
Copy

Response with carousel's payload example:

JSON
    
 
{    "results": {        "comment": {            "message": "",            "payload": {                "cards": [                    {                        "image": "http://url.com/gambar.jpg",                        "title": "Atasan Blouse Tunik Wanita Baju Muslim Worie Longtop",                        "description": "Oleh sippnshop\n96% (666 feedback)\nRp 49.000.00,-\nBUY 2 GET 1 FREE!!!",                        "default_action": {                            "type": "postback",                            "postback_text": "Load more",                            "payload": {                                "url": "http://url.com/baju?id=123&track_from_chat_room=123",                                "method": "get",                                "payload": null                            }                        },                        "buttons": [                            {                                "label": "button1",                                "postback_text": "Load more",                                "type": "postback",                                "payload": {                                    "url": "http://somewhere.com/button1",                                    "method": "get",                                    "payload": null                                }                            },                            {                                "label": "button2",                                "postback_text": "",                                "type": "link",                                "payload": {                                    "url": "http://somewhere.com/button2?id=123",                                    "method": "get",                                    "payload": null                                }                            }                        ]                    }                ]            },            "timestamp": "2018-03-13T09:53:25Z",            "type": "carousel",            "user": {                "avatar_url": "https://res.cloudinary.com/qiscus/image/fetch/http://myimage.com/image.jpg",                "user_id": "guest@qiscus.com",                "username": "guest"            }        }    },    "status": 200}
Copy

file_attachment type

Message text will be the caption. An request file_attachment payload:

JSON
    
 
{    "user_id": "guest@qiscus.com",    "room_id": "457",    "type" : "file_attachment",    "payload": {        "url": "https://res.cloudinary.com/qiscus/image/upload/USWiylE7Go/ios-15049438515185.png",        "caption": "Ini gambar siapa?",        "file_name": "",        "size": 0,        "pages": 1    }}
Copy

Response with file_attachment's payload example:

JSON
    
 
{  "results": {    "comment": {      "message": "[file] https://res.cloudinary.com/qiscus/image/upload/USWiylE7Go/ios-15049438515185.png [/file]",      "payload": {        "url": "https://res.cloudinary.com/qiscus/image/upload/USWiylE7Go/ios-15049438515185.png",        "caption": "Ini gambar siapa?",        "file_name": "",        "size": 0,        "pages": 1      },      "timestamp": "2018-03-12T08:12:19Z",      "type": "file_attachment",      "user": {        "avatar_url": "http://myimage.com/image.jpg",        "user_id": "guest@qiscus.com",        "username": "Qiscus Demo"      }    }  },  "status": 200}
Copy

custom type

Request payload must be valid JSON string object, and it will return as what you have inputted. The JSON payload must have any type and content object. Type must be string, for example if you want to create promo payload, it can be promo. The content can be anything, such as object, array, number or string in JSON. By this, you can input, let say XML string in payload.content object value and later you can parse it by yourself by overriding Qiscus Chat SDK client chat view.

Example request payload:

JSON
    
 
{  "user_id": "guest@qiscus.com",  "room_id": "457",  "type": "custom",  "payload": {    "type": "promo", // sub type of custom payload    "content": {        "date": "2017-09-09"    } // can be anything: object, array, string, number in JSON  }}
Copy

Response with custom's payload example:

JSON
    
 
{  "results": {    "comment": {      "message": "",      "payload": {        "content": {            "date": "2017-09-09"        }        "type": "promo"      },      "timestamp": "2018-03-12T08:11:52Z",      "type": "custom",      "user": {        "avatar_url": "http://myimage.com/image.jpg",        "user_id": "guest@qiscus.com",        "username": "Qiscus Demo"      }    }  },  "status": 200}
Copy

Load Message

To retrieve the messages data.

Request:

HTTP
    
 
https://api.qiscus.com/api/v2.1/rest/load_comments
Copy

Headers:

Bash
    
 
"QISCUS-SDK-APP-ID":"Your Qiscus App Id""QISCUS-SDK-SECRET":"Your Qiscus SDK Secret Key"
Copy

Endpoint:

[GET] /load_comments

Params:

Key	Type	Description
room_id (required)	int	chat room Id
page (optional)	int	number of page
limit (optional)	int	default is 20 messages, max 100, more than 100 will return 20 messages

Example request:

Bash
    
 
curl -X GET \  'https://api.qiscus.com/api/v2.1/rest/load_comments?room_id=1375619&page=1&limit=20' \  -H 'QISCUS-SDK-APP-ID: sdksample' \  -H 'QISCUS-SDK-SECRET: 2820ae9dfc5362f7f3a10381fb89afc7'
Copy

Response:

JSON
    
 
{  "results": {    "comments": [      {        "message": "testing message 1",        "timestamp": "2017-02-07T19:01:00Z",        "type": "text",        "payload": null,        "user": {          "avatar_url": "https://myimagebucket.com/image.jpg",          "user_id": "user1@email.com",          "username": "Liu Kang"        }      },      {        "message": "testing message 2",        "timestamp": "2017-02-07T19:03:00Z",        "type": "text",        "payload": null,        "user": {          "avatar_url": "https://myimagebucket.com/image.jpg",          "user_id": "user2@email.com",          "username": "Sonya"        }      }    ]  },  "status": 200}
Copy

Post System Event Message

To send event system message such as creating group, join room, remove member, and other use case that need to notify an event to participants in a chat room.

Request:

HTTP
    
 
https://api.qiscus.com/api/v2.1/rest/post_system_event_message
Copy

Headers:

Bash
    
 
"Content-Type":"application/json""QISCUS-SDK-APP-ID":"Your Qiscus App Id""QISCUS-SDK-SECRET":"Your Qiscus SDK Secret Key"
Copy

Endpoint:

[POST] /post_system_event_message

Params:

Key	Type	Description
system_event_type	string	set "custom" value, to able to use this system event
room_id	string	it can be room id or room unique id specified by client or auto generated by server
message	string	Max message content is 4000 chars
payload	json	Desired payload that you can define based on your needs
extras	json	Meta data in message

An example request system event:

JSON
    
 
{  "system_event_type": "custom",  "room_id": "1375619",  "message": "Hello Qiscus",  "payload": {      "type": "add_admin",      "admin_email": "admin@email.com"  },  "extras": {        "qiscus_ios_pn": {            "aps": {                "content-avaibility": 1             }        }    }}
Copy

if extras contains key qiscus_ios_pn, it will override payload value that for APNS PN.

Response:

JSON
    
{    "results": {        "comment": {            "message": "Admin is being set",            "payload": {                "payload": {                    "admin_email": "admin@email.com",                    "type": "add_admin"                },                "room_name": "Qiscsu Demo Update Room",                "type": "custom"            },            "timestamp": "2019-11-03T15:11:01Z",            "type": "system_event",            "user": {                "avatar_url": "https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/75r6s_jOHa/1507541871-avatar-mine.png",                "extras": {},                "user_id": "system@sdksample.qiscus.com",                "username": "System"            }        }    },    "status": 200}
Copy

Delete messages

Delete message with unique Ids of the messages, once it successful delete the message it will send realtime delete event to client-side hence client able to handle respectively

Request:

HTTP
    
 
https://api.qiscus.com/api/v2.1/rest/delete_messages
Copy

Headers:

Bash
    
 
"Content-Type":"application/json""QISCUS-SDK-APP-ID":"Your Qiscus App Id""QISCUS-SDK-SECRET":"Your Qiscus SDK Secret Key"
Copy

Endpoints:

[DELETE] /delete_messages

Params:

Key	Type	Description
unique_ids[]	string[]	unique_ids of the messages, you can get unique id from comment object, max 3 unique Ids

Example request:

Bash
    
 
curl --location --request DELETE 'https://api3.qiscus.com/api/v2.1/rest/delete_messages' \--header 'Content-Type: application/json' \--header 'QISCUS-SDK-APP-ID: sdksample' \--header 'QISCUS-SDK-SECRET: 2820ae9dfc5362f7f3a10381fb89afc7' \--data-raw '{    "unique_ids":[        "javascript-1605710511771"    ]}'
Copy

Response:

Bash
    
 
{    "results": {        "message": "messages successfully deleted"    },    "status": 200}
Copy

Last updated on

Was this page helpful?