Retrieve all chat messages.

get

https://api.interplai.io/v2/zones/{zoneId}/users/{userId}/chatmessages

Retrieve all chat messages for a user account, where the user is either the driver or the agent. Messages include all messages sent to and from customers for all trips.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

zoneId

string

required

Interplai-specified identifier of the zone.

userId

string

required

Unique identifier of the user.

Query Params

limit

int32

1 to 100

Defaults to 10

The maximum number of API key records to be returned. The max can be set anywhere between 1 and 100.

page

string

Defaults to 1

Set the page number to skip over a certain number of records. Each page will contain the number of records set by the limit. For example, if limit is set to 10 and page is set to 5, then the first four pages are skipped corresponding to records 1-40, and page 5 is displayed with records 41-50.

orderby

string

Defaults to createdTimestamp

By default, records are retrieved in descending order by the createdTimestamp field. The sort order can be changed using the orderby parameter and setting it to any field in an object.

sortby

string

enum

Defaults to desc

Choose for records to be in descending or ascending order.

desc : records are displayed in descending order.

asc : records are displayed in ascending order.

Allowed:

status

string

enum

Current status of the chat.

active : the chat session is ongoing.

inactive : the chat session is terminated.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401Invalid API key.

404Not found - zone or user.