API Reference

Send Message

post
https://engagement-api.pypestream.com/messaging/v1/chats//message

Use this method to send a message.

Path Params
uuid
required

The 'chat_id' received with the Create User response

Body Params

Sends a new message to the engagement

string

An object for the embedded object data.

string

The id of the campaign this message originated from.

string

Client generated unique message id.

string

A unique ID set by the client which can be used to correlate the responding acknowledgement of the request.

uri

A URL to a file to embed in the message.

string

Indicates if the file is available for downloading from the URL. States are: uploading, ready, failed

uuid
required

The 'id' received with the Create User response

string
required

Indicates the source of the message. Possible value(s): anonymous_consumer

string
required

Platform used by the client app. Possible value(s): pypestream_widget

string
required

The message that's being sent

string
required

Message type. We support text and embed. If it is text, then the msg field is required, but if it is embed, then the msg will be null, and the app_object and secure_app_object fields are required.

boolean

Flags whether this message should be written to the persistent history.

boolean

Flags whether this is a secure message and thus should not be persisted.

uuid
required

The 'id' received with the Create User response

string
required

API version

Responses
204

Successful operation

Callback

Updated 7 months ago

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

Updated 7 months ago