Qodex.ai

Send Message

POST {{HOST}}/v2/active-rooms/<room_id>/send-message

You can use this API to send messages to a single peer, a set of peers (a particular role), or all connected peers in the active room. This API supports arguments such as peer_id and role to implement this.

  1. If peer_id is specified -- message will be sent only to the specified connected peer.
  2. If the role is specified -- message will be sent to all the connected peers assigned with that particular role.
  3. If both peer_id and role are specified -- preference will be given to the peer_id and the message will be sent only to the specified connected peer.
  4. If both peer_id and role are not specified -- message(broadcast) will be sent to all the connected peers.

Arguments

NameTypeDescriptionRequired
room_id
— path param		stringUnique identifier of the room where the peer is active.

Example: 627cda81ab4f3b56a077dc33		Yes
message
— body param		stringActual message to be sent.Yes
peer_id
— path param		stringUnique identifier of the peer/participant for which you wish to send the message.

Example: 1038fa72-9345-4651-beab-436f9242ebf4		No
role
— body param		stringYou can use this to send the message to a set of peers (a particular role).No
type
— body param		stringIndicates the type of message sent, for example, chat or emoji.No

Why would you use this API?

  • Based on your requirements, you can use this API to send a broadcast message, private message, or reactions like emojis.

Example1 - Inform unavailability of teacher

  • Suppose a teacher cannot attend a virtual classroom session at the last minute; you can inform all the connected peers (students) by sending a broadcast message to inform the teacher's unavailability.

Example2 - Poker handler

  • You can build a handler for a multiplayer game like Poker using this API in conjunction with the peer.join.success webhook event. Let's consider below scenario:
  • Four users join the game and start playing -- your app server stores the user_id for each user.
  • {
    peer_id: 018b84da-0786-48c5-a3a6-02961d9eac03, // will send the data only to peerid specified.
    message: ", type:custom    event"
    }
  • {
    message: ", // will send the data to all the peers in the active room as peer_id or role is not specified. type:custom_event"
    }

Request Body

{"peer_id"=>"", "role"=>"", "message"=>"hi", "type"=>"chat"}