Send Ptv - File

POST 
/api/v2/instance/:instanceId/send/ptv-file

Send PTV - File

This endpoint makes it possible to directly send pre-recorded video (PTV) files within an instance..

Request

Path Parameters

instanceId stringrequired

ID of the instance.

multipart/form-data

Body

required

recipient Recipientrequired

Contact number or group id

attachment binaryrequired

Load the media file.

delay Delay

Default value: 1200

Defines the delay with which the message will be sent in milliseconds.

Responses

201

ResponseSendMessage

application/json

Schema

Schema

messageId stringrequired
keyId stringrequired
keyFromMe booleanrequired
keyRemoteJid stringrequired
keyParticipant string
pushName stringrequired
contentType stringrequired
isGroup booleanrequired
content objectrequired
source stringrequired
messageTimestamp numberrequired
createdAt date-timerequired

Default value: 2023-12-13T17:55:01.032Z

instanceInstanceId stringrequired

Default value: 2023-12-13T17:55:01.032Z

externalAttributes stringrequired

Example (from schema)

{
  "messageId": "string",
  "keyId": "string",
  "keyFromMe": true,
  "keyRemoteJid": "string",
  "keyParticipant": "string",
  "pushName": "string",
  "contentType": "string",
  "isGroup": true,
  "content": {},
  "source": "string",
  "messageTimestamp": 0,
  "createdAt": "2024-04-14T14:11:05.685Z",
  "instanceInstanceId": "2023-12-13T17:55:01.032Z",
  "externalAttributes": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

403

ForbiddenException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

404

NotFoundException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...