Generate Chat Summary

This endpoint initiates the process of generating a chat summary for a specific contact.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Required Parameter (one of the following):

  • phoneNumber: The phone number of the contact (sent in the request body). Phone number format should exclude the leading "+" symbol.
  • email: The email address of the contact (sent in the request body).

Response:

Upon successful initiation of the summary generation process, the endpoint returns a JSON response with:

  • success: A boolean indicating success (true).
  • message: A message indicating that the chat summary is being generated.

Error Handling:

The endpoint will return appropriate error responses in the following cases:

  • Missing Required Parameters: If both phoneNumber and email are missing, a 400 Bad Request error is returned.
  • Invalid API Key: If the provided API key is invalid, a 401 Unauthorized error is returned.
  • Contact Not Found: If the specified phone number or email address does not match an existing contact, a 404 Not Found error is returned.
  • Internal Server Error: If an error occurs during message publishing to Pub/Sub, a 500 Internal Server Error is returned.

Notes:

  • This endpoint triggers the chat summary generation process asynchronously. You won't receive the actual summary content in the response.
  • The actual chat summary generation happens later and may take some time depending on the amount of chat data involved.
Query Params
string

Your unique API key for authentication.

Body Params
string

The phone number of the contact. Phone number format should exclude the leading "+" symbol.

string

The email address of the contact

Responses

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