API Reference

Send a file message to an active conversation via a url

post
https://example.com/api/ext/v3/conversations/messages/fileViaUrl
  • Status code 200 means the message was accepted by WATI, not delivered yet.
  • To know if a message is failed, listen to the Session Message Failed webhook.
  • To know if a message is sent successfully, listen to Delivered/Read/Reply webhooks.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request model for sending a file message.

string
required

The target conversation in the following formats:

  • ConversationId: The unique ID of a conversation.
  • PhoneNumber: The conversation's phone number (e.g., 14155552671).
  • Channel:PhoneNumber: A combination of the channel (name or phone number) and the recipient's phone number (e.g., MyChannel:1415552671, 123456789:1415552671).
  • BSUID: The recipient's Business-Scoped User ID (e.g., ML.2011135123094924).
  • Channel:BSUID: A combination of the channel (name or phone number) and the recipient's BSUID (e.g., MyChannel:ML.2011135123094924, 123456789:ML.2011135123094924).
string
required

File to send.

string | null

Optional caption for the file.

boolean
Defaults to true

Whether to send an Instagram message as a bot. Defaults to true.
Set to false to use the human-agent reply window and tag.
Ignored for non-Instagram conversations.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Updated about 5 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago