Send Catalog

POST 
/business/sendCatalog

Send Catalog

Request

application/json

Body

required

numbers string[]required

required

options object

delay number

The delay property can receive either a single integer value or an array of two-position integers.

quoted object

Inform the id of the message you want to quote, remembering that you can only quote one message at a time in the chat.

messageId stringrequired

mentions object

Mention people in groups or simple chats.

everyone boolean

Default value: false

Pass this property to "true" to mention everyone in a group
default: false

ghostMention boolean

Default value: false

Mention all participants in a group without directly referencing them
default: false

mentioned string[]

The mention of participants is valid only for groups

presence Presence

Default value: paused | composing | unavailable | available | recording

Set your status in chat

catalogMessage object
title string
description string
coverUrl string

Responses

201

application/json

Schema

Schema

action stringrequired
header object
queueId string
status stringrequired
progress numberrequired
data object
message objectrequired
jids string[]required
messagesIds string[]required
queueTimestamp numberrequired

Example (from schema)

{
  "action": "string",
  "header": {
    "queueId": "string",
    "status": "string",
    "progress": 0
  },
  "data": {
    "message": {},
    "jids": [
      "string"
    ],
    "messagesIds": [
      "string"
    ]
  },
  "queueTimestamp": 0
}

Loading...