API Reference

Create User

post
https://engagement-api.pypestream.com/messaging/v1/consumers/anonymous_session

The Engagement API provides a user creation method, which is essential before starting an engagement. Follow the instructions below to set up a user properly.

Body Params

Creates an User

uuid
required

The unique identifier of the Pype that the user will engage with.

string

The category of the app. Valid options are: 'consumer'.

string
required

The language locale used by the client's browser (e.g., 'en-US').

string

The device's universally unique identifier (UUID) connecting to the conversation.

string

The category of the client device. Valid options include: 'apple,' 'android', 'browser,' 'mobile-browser,' and 'web.'

string

The IP address of the client.

string

The language used in the microapp.

string

The most recently visited URL by the client.

string

The geographical location of the client (e.g., 'Richmond, VA, United States').

string

Additional user information in JSON format.

string

The client's platform or operating system (e.g., 'ios', 'android', 'MacOSX', etc.).

string
required

The website that referred the client.

string

The screen resolution of the client's device (e.g., '1280x720').

string

The APN/GCM token is provided by the client.

string
required

The browser used by the client.

Headers
uri

When a valid URL is provided in this header, all asynchronous events will be sent to the specified URL as POST requests. The request body will contain a JSON object with two fields: type (event name) and payload (an object containing the same information that would have been sent through WebSocket).

Responses

Callback

Updated 9 months ago

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

Updated 9 months ago