API Reference

Send a file message to an active conversation

post
https://example.com/api/ext/v3/conversations/messages/file
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

BSUID Support: The conversation target parameter now supports additional identifier formats:

FormatExampleDescription
Conversation ID685bd235e6119686e693a093Direct conversation lookup (existing)
Phone Number14155552671Most recent open conversation for phone (existing)
Contact ID507f1f77bcf86cd799439011Most recent open conversation for contact (new)
BSUIDUS.123124141512Most recent open conversation for BSUID (new)
Channel:PhoneMyChannel:14155552671Channel-scoped conversation (existing)
Channel:ContactIdMyChannel:507f...Channel-scoped by contact ID (new)
Channel:BSUIDMyChannel:US.123124141512Channel-scoped by BSUID (new)

Note: Returns 409 Conflict if multiple open conversations exist for the contact without a channel specified.

Body Params
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).
file
required

File to send.

Responses

401

The request is unauthorized.

429

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

Updated 2 months 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 2 months ago