{
"message_id": "<string>",
"agent_response": "<string>",
"conversation_id": "<string>",
"timestamp": 123,
"handoff_reason": "<string>",
"no_response_reason": "<string>",
"quick_replies": [
"<string>"
],
"product_variant_ids": [
"<string>"
]
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}Agent Test
Test Agent
Sends user_msg through the full agent pipeline and returns a synchronous test response without requiring a real consumer number. Reuse the optional conversation_id to continue a multi-turn test.
POST
https://api.ycloud.com/v2
/
metaBusinessAgents
/
{entityId}
/
tests
{
"message_id": "<string>",
"agent_response": "<string>",
"conversation_id": "<string>",
"timestamp": 123,
"handoff_reason": "<string>",
"no_response_reason": "<string>",
"quick_replies": [
"<string>"
],
"product_variant_ids": [
"<string>"
]
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"target": "<string>",
"docUrl": "<string>",
"requestId": "<string>",
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}Authorizations
Path Parameters
WhatsApp Business Phone Number ID that owns the Meta Business Agent.
Body
application/json
Response
Operation completed successfully.
Meta message ID for the generated test response.
Generated response text.
Conversation context ID to pass on subsequent test turns.
Unix timestamp in seconds.
Reason the agent decided a human should take over, when present.
Reason the agent produced no response, when present.
Suggested quick-reply labels, when present.
Product variant IDs referenced by the response, when present.