Messages · Channelize.io

This section contains what all messages related actions can be performed using Application APIs.

Send Messages

Sends multiple types of messages in conversations i.e Text messages, File messages (Image, Audio & Video), Location messages, Stickers & GIFs.

POST https://api.channelize.io/v1/messages/send

The contentType and attachmentType parameters are used to define the type of message. contentType can accept below values:

0 - text/media
1 - meta messages
2 - sticker/gif
3 - location messages

attachmentType is used to further classify text/media contentType and can acceppt following values: text, image, audio and video. A single value or multiple comma separated values can be send.

Body for Text Message

Name	Type	Required	Default	Description
id	string	no	auto generated	The unique ID of the message.
body	string	yes	null	The content of the message.
ownerId	string	yes	null	The unique ID of user who sent the message.
contentType	number	no	0	Specifies the type of message. Allowed values are 0, 1, 2 and 3.
userId	string	yes (if no chatId)	null	The unique ID of the specific user who'll get the message.
chatId	string	yes (if no userId)	null	The unique ID of the conversation where the message is sent to.
attachmentType	string	no	text	Specifies the type of attachment. Allowed values are text, image, audio and video.
tags	array	yes	null	Specifies an array of members that are tagged in a message. If no member is tagged, then pass an empty array.

Body for Image Attachment

Name	Type	Required	Default	Description
id	string	no	auto generated	The unique ID of the message.
ownerId	string	yes	null	The unique ID of user who sent the message.
contentType	number	yes	2	Specifies the type of message. Allowed values are 0, 1, 2 and 3.
userId	string	yes (if no chatId)	null	The unique ID of the specific users who'll get the message.
chatId	string	yes (if no userId)	null	The unique ID of the conversation where the message is sent to.
attachmentType	string	no	image	Specifies the type of attachment. Allowed values are text, image, video, audio.
file	binary	yes	null	The file in the message.

Body for Audio/Video Attachment

Name	Type	Required	Default	Description
id	string	no	auto generated	The unique ID of the message.
ownerId	string	yes	null	The unique ID of user who sent the message.
contentType	number	no	2	Specifies the type of message. Allowed values are 0, 1, 2 and 3
userId	string	yes (if no chatId)	null	The unique ID of the specific users who'll get the message.
chatId	string	yes (if no userId)	null	The unique ID of the conversation where the message is sent to.
attachmentType	string	no	audio/video	Specifies the type of attachment. Allowed values are text, image, video, audio.
file	binary	yes	null	The file in the message.

Body for Location Attachment

Name	Type	Required	Default	Description
id	string	no	auto generated	The unique ID of the message.
ownerId	string	yes	null	The unique ID of user who sent the message.
contentType	number	yes	3	Specifies the type of message. Allowed values are 0, 1, 2 and 3.
userId	string	yes (if no chatId)	null	The unique ID of the specific users who'll get the message.
chatId	string	yes (if no userId)	null	The unique ID of the conversation where the message is sent to.
attachmentType	string	no	location	Specifies the type of attachment. Allowed values are text, image, video, audio.
data	object	yes	null	Specifies the details of the coordinates stored in the message i.e Latitude, Longitude, Title & Address. Latitude and longitude are number type. Title and address are string types. All four entities are required fields.

Response

Status Code : 201

{
    "id": "164acec2-6740-11e9-ad5e-e1737588b99c",
    "chatId": "201",
    "attachmentType": "text",
    "contentType": 0,
    "status": "success",
    "body": "test message",
    "ownerId": "35",
    "recipients": [
        {
            "id": "164acec0-6740-11e9-ad5e-e1737588b99c",
            "recipientId": "35",
            "status": 1,
            "createdAt": "2019-04-25T09:54:16.108Z"
        },
        {
            "id": "164acec1-6740-11e9-ad5e-e1737588b99c",
            "recipientId": "18859",
            "status": 1,
            "createdAt": "2019-04-25T09:54:16.108Z"
        }
    ],
    "owner": {
        "id": "35",
        "displayName": "Channelize Demo User",
        "profileImageUrl": "https://channelize.io/profile.jpg"
    },
    "tags": []
}

Broadcast Messages

Allows 1-to-N broadcast of messages.

POST https://api.channelize.io/v1/messages/broadcast

NOTE: Supports all types of messages supported by Send Messages API call. To know the body of different types of supported messages check Application API > Messages > Send Messages.

Response Body

Status Code : 200

[]

Forward Messages

Forward a message into one or multiple conversations. Consider the forwarded messages as a new instance of the message.

POST https://api.channelize.io/v1/messages/forward

Body Params

This table lists all possible parameters body of this API request supports.

Name	Type	Required	Default	Description
messageIds	array	yes	null	Specifies an array of one or more unique IDs of the messages to forward.
ownerId	string	yes	null	The unique ID of user who forwarded the message.
conversationIds	array	yes (in case of no userIds)	null	Specifies an array of one or more unique IDs of the conversations where the message is sent to.
userIds	array	yes (in case of no conversationIds)	null	Specifies an array of one or more unique IDs of the users who'll get the message.

Response

Status Code : 201

[
    "4b607da8-23cb-42e5-868f-65d28da2bb77"
]

Quote/Reply a Message

Quote/Reply a past message of conversaton.

POST https://api.channelize.io/v1/messages/quote

Body Params

This table lists all possible parameters body of this API request supports.

Name	Type	Required	Default	Description
id	string	no	auto generated	The unique ID of the message.
body	string	yes	null	The content of the message.
ownerId	string	yes	null	The unique ID of user who sent the message.
parentMsgId	string	yes	null	The unique id of the original message.
contentType	string	no	null	Specifies the type of message. Allowed values are 0, 1, 2 and 3.
attachmentType	string	no	text	Specifies the type of attachment. Allowed values are text, image, audio, and video.
tags	array	yes	null	Specifies an array of members that are tagged in a message. If no member is tagged, then pass an empty array.

Delete Messages

Deletes a message from a conversation.

POST https://api.channelize.io/v1/messages/delete

Body Params

This table lists all possible parameters body of this API request supports.

Name	Type	Required	Default	Description
messageIds	array	yes	null	Specifies an array of one or more unique IDs of the messages to delete from a conversation.

Response

Status Code : 204

No Content

Delete Messages for Everyone / Recall sent messages

Recalls messages that you sent from the inbox of the recipients. You can also substitute a replacement message.

POST https://api.channelize.io/v1/messages/delete_for_everyone

Body Params

This table lists all possible parameters body of this API request supports.

Name	Type	Required	Default	Description
messageIds	array	yes	null	Specifies an array of one or more unique IDs of the messages to recall from a conversation.

Response

Status Code : 200

[]

Mark as Read

Mark a message in a conversation as read for a given user.

PUT https://api.channelize.io/v1/messages/{message_id}/mark_as_read

Path Params

This table lists all possible parameters this API request supports.

name	Type	Required	Default	Description
message_id	string	yes	null	The unique ID of the message to mark as read.

Response

Status Code : 204

No Content

Get Unread Message Count

Retrieves the total number of unread messages for a user.

GET https://api.channelize.io/v1/messages/unread/count

Response

Status Code : 200

{
    "count": 12
}