Retrieve Meta Business Agent conversation turns

get

https://api.ycloud.com/v2/metaBusinessAgents/{entityId}/conversationTurns

Retrieves conversation turns for one WhatsApp user. entityId is the WhatsApp Business
Phone Number ID. Timestamp boundaries are inclusive and use Unix epoch milliseconds.
Supply at most one of before and after; cursors are opaque. Continue pagination while
paging.next is present, including when the current data array is empty.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityId

string

required

length ≥ 1

Endpoint-specific Meta Business Agent entity ID. Budget and Conversation Turns operations
use the tenant-owned WhatsApp Business Phone Number ID.

Query Params

user_phone_number

string

required

^[1-9][0-9]{1,14}$

WhatsApp user phone number including the country code, with digits only and no leading +, spaces, or separators.

start_timestamp_ms

int64

≥ 0

Inclusive start time as Unix epoch milliseconds.

end_timestamp_ms

int64

≥ 0

Inclusive end time as Unix epoch milliseconds. Must be greater than or equal to start_timestamp_ms when both are supplied.

before

string

length ≥ 1

Opaque backward-pagination cursor. Do not combine with after.

after

string

length ≥ 1

Opaque forward-pagination cursor. Do not combine with before.

limit

int32

≥ 1

Maximum number of conversation turns to return.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Successfully retrieved conversation turns.

400The request is invalid.

401A valid API key is required.

403The tenant does not own the requested resource or lacks the required Meta permission.

404The requested Meta Business Agent resource was not found.

422The request is well-formed but cannot be processed.

429Too many requests were sent to YCloud or Meta.

500An internal server error occurred.

502Meta Business Agent returned an invalid or unavailable upstream response.