Group Message Endpoints
Create Group Messages
Send a message to a group chat
POST
Sending Group Messages:
-
The agent’s phone number must first be added to the group chat before messages can be sent.
-
You’ll need the thread_id of the group chat to send messages. This is provided when you create a group or in webhook events.
Example Request
Text Message to Group
Media Message to Group
To send a document to a group:
Using the Universal Endpoint for Groups
You can also use the newer universal endpoint for group messages:
Important Notes for Group Media Messages
- For group messages, you need a valid
thread_id
instead of ato
number. - The
caption
field is optional. You can send media without a caption if desired. - The same media type and size restrictions apply as with individual messages:
- Images: Generally up to 5MB
- Videos: Generally up to 16MB
- Audio: Generally up to 16MB
- Documents: Generally up to 100MB
- The agent must be a member of the group before sending messages.
Path Parameters
Body
application/json
Response
200
application/json
Message sent successfully
The response is of type object
.