{
"id": "wam_group_01",
"from": "+16315551111",
"groupId": "120363345678901234@g.us",
"type": "text",
"status": "accepted",
"createTime": "2023-11-07T05:31:56Z",
"direction": "outbound",
"recipients": [
{
"id": "<string>",
"status": "accepted",
"recipientUserId": "<string>",
"parentRecipientUserId": "<string>",
"to": "<string>",
"customerProfile": {
"name": "John",
"username": "john_doe"
},
"regionCode": "<string>",
"statusTime": "2023-11-07T05:31:56Z",
"sendTime": "2023-11-07T05:31:56Z",
"deliverTime": "2023-11-07T05:31:56Z",
"readTime": "2023-11-07T05:31:56Z",
"errorCode": "<string>",
"errorMessage": "<string>",
"pricingCategory": "group_marketing",
"pricingType": "regular",
"pricingModel": "PMP",
"bidPricingFlag": true,
"tier": "<string>",
"totalPrice": 123,
"currency": "<string>"
}
],
"wamid": "wamid.HBg...",
"groupName": "New Purchase Inquiry",
"externalId": "<string>",
"template": {
"name": "sample_whatsapp_template",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"sub_type": "quick_reply",
"index": 4,
"parameters": [
{
"type": "text",
"text": "<string>",
"payload": "<string>",
"coupon_code": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"gif": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"video": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"document": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"limited_time_offer": {
"expiration_time_ms": "1698562800000"
},
"action": {
"thumbnail_product_retailer_id": "2lc20305pt",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<string>"
}
]
}
],
"flow_token": "<string>",
"flow_action_data": {},
"order_details": {
"currency": "<string>",
"order": {
"status": "pending",
"type": "<string>",
"catalog_id": "<string>",
"items": [
{
"name": "<string>",
"amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"quantity": 123,
"retailer_id": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sale_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"country_of_origin": "<string>",
"importer_name": "<string>",
"importer_address": "<string>"
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"tax": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"discount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"expiration": {
"timestamp": "1727438564",
"description": "<string>"
},
"description": "<string>"
},
"reference_id": "<string>",
"total_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"type": "<string>",
"payment_settings": [
{
"type": "payment_gateway",
"payment_gateway": {
"type": "billdesk",
"configuration_name": "<string>",
"billdesk": {
"additional_info1": "<string>",
"additional_info2": "<string>",
"additional_info3": "<string>",
"additional_info4": "<string>",
"additional_info5": "<string>",
"additional_info6": "<string>",
"additional_info7": "<string>"
},
"payu": {
"udf1": "<string>",
"udf2": "<string>",
"udf3": "<string>",
"udf4": "<string>"
},
"razorpay": {
"receipt": "<string>",
"notes": {}
},
"zaakpay": {
"extra1": "<string>",
"extra2": "<string>"
}
}
}
]
}
},
"order_status": {
"reference_id": "<string>",
"order": {
"status": "pending",
"type": "<string>",
"catalog_id": "<string>",
"items": [
{
"name": "<string>",
"amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"quantity": 123,
"retailer_id": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sale_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"country_of_origin": "<string>",
"importer_name": "<string>",
"importer_address": "<string>"
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"tax": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"discount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"expiration": {
"timestamp": "1727438564",
"description": "<string>"
},
"description": "<string>"
}
},
"location": {
"latitude": 123,
"longitude": 123,
"name": "<string>",
"address": "<string>"
},
"group_id": "120363345678901234@g.us"
}
],
"cards": [
{
"card_index": 4,
"components": [
{
"type": "header",
"sub_type": "quick_reply",
"index": 4,
"parameters": [
{
"type": "text",
"text": "<string>",
"payload": "<string>",
"coupon_code": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"gif": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"video": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"document": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"limited_time_offer": {
"expiration_time_ms": "1698562800000"
},
"action": {
"thumbnail_product_retailer_id": "2lc20305pt",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<string>"
}
]
}
],
"flow_token": "<string>",
"flow_action_data": {},
"order_details": {
"currency": "<string>",
"order": {
"status": "pending",
"type": "<string>",
"catalog_id": "<string>",
"items": [
{
"name": "<string>",
"amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"quantity": 123,
"retailer_id": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sale_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"country_of_origin": "<string>",
"importer_name": "<string>",
"importer_address": "<string>"
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"tax": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"discount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"expiration": {
"timestamp": "1727438564",
"description": "<string>"
},
"description": "<string>"
},
"reference_id": "<string>",
"total_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"type": "<string>",
"payment_settings": [
{
"type": "payment_gateway",
"payment_gateway": {
"type": "billdesk",
"configuration_name": "<string>",
"billdesk": {
"additional_info1": "<string>",
"additional_info2": "<string>",
"additional_info3": "<string>",
"additional_info4": "<string>",
"additional_info5": "<string>",
"additional_info6": "<string>",
"additional_info7": "<string>"
},
"payu": {
"udf1": "<string>",
"udf2": "<string>",
"udf3": "<string>",
"udf4": "<string>"
},
"razorpay": {
"receipt": "<string>",
"notes": {}
},
"zaakpay": {
"extra1": "<string>",
"extra2": "<string>"
}
}
}
]
}
},
"order_status": {
"reference_id": "<string>",
"order": {
"status": "pending",
"type": "<string>",
"catalog_id": "<string>",
"items": [
{
"name": "<string>",
"amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"quantity": 123,
"retailer_id": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sale_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"country_of_origin": "<string>",
"importer_name": "<string>",
"importer_address": "<string>"
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"tax": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"discount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"expiration": {
"timestamp": "1727438564",
"description": "<string>"
},
"description": "<string>"
}
},
"location": {
"latitude": 123,
"longitude": 123,
"name": "<string>",
"address": "<string>"
},
"group_id": "120363345678901234@g.us"
}
]
}
]
}
]
}
]
},
"text": {
"body": "<string>",
"preview_url": true
},
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"video": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"audio": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"document": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sticker": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"updateTime": "2023-11-07T05:31:56Z",
"sendTime": "2023-11-07T05:31:56Z",
"groupMessageType": "group_marketing",
"groupMemberCount": 123,
"recipientCount": 123,
"sent": 123,
"delivered": 123,
"read": 123,
"failed": 123,
"errorCode": "<string>",
"errorMessage": "<string>",
"totalPrice": 123,
"currency": "USD"
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}WhatsApp Groups
Retrieve a group message
Retrieves one outbound group message and all records in its fixed recipient snapshot.
status is the group-level send status. Member statuses and pricing are returned in recipients. If sending fails before a reliable snapshot is available, the recipient counters are omitted and recipients is empty.
GET
https://api.ycloud.com/v2
/
whatsapp
/
groupMessages
/
{id}
{
"id": "wam_group_01",
"from": "+16315551111",
"groupId": "120363345678901234@g.us",
"type": "text",
"status": "accepted",
"createTime": "2023-11-07T05:31:56Z",
"direction": "outbound",
"recipients": [
{
"id": "<string>",
"status": "accepted",
"recipientUserId": "<string>",
"parentRecipientUserId": "<string>",
"to": "<string>",
"customerProfile": {
"name": "John",
"username": "john_doe"
},
"regionCode": "<string>",
"statusTime": "2023-11-07T05:31:56Z",
"sendTime": "2023-11-07T05:31:56Z",
"deliverTime": "2023-11-07T05:31:56Z",
"readTime": "2023-11-07T05:31:56Z",
"errorCode": "<string>",
"errorMessage": "<string>",
"pricingCategory": "group_marketing",
"pricingType": "regular",
"pricingModel": "PMP",
"bidPricingFlag": true,
"tier": "<string>",
"totalPrice": 123,
"currency": "<string>"
}
],
"wamid": "wamid.HBg...",
"groupName": "New Purchase Inquiry",
"externalId": "<string>",
"template": {
"name": "sample_whatsapp_template",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"sub_type": "quick_reply",
"index": 4,
"parameters": [
{
"type": "text",
"text": "<string>",
"payload": "<string>",
"coupon_code": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"gif": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"video": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"document": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"limited_time_offer": {
"expiration_time_ms": "1698562800000"
},
"action": {
"thumbnail_product_retailer_id": "2lc20305pt",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<string>"
}
]
}
],
"flow_token": "<string>",
"flow_action_data": {},
"order_details": {
"currency": "<string>",
"order": {
"status": "pending",
"type": "<string>",
"catalog_id": "<string>",
"items": [
{
"name": "<string>",
"amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"quantity": 123,
"retailer_id": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sale_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"country_of_origin": "<string>",
"importer_name": "<string>",
"importer_address": "<string>"
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"tax": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"discount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"expiration": {
"timestamp": "1727438564",
"description": "<string>"
},
"description": "<string>"
},
"reference_id": "<string>",
"total_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"type": "<string>",
"payment_settings": [
{
"type": "payment_gateway",
"payment_gateway": {
"type": "billdesk",
"configuration_name": "<string>",
"billdesk": {
"additional_info1": "<string>",
"additional_info2": "<string>",
"additional_info3": "<string>",
"additional_info4": "<string>",
"additional_info5": "<string>",
"additional_info6": "<string>",
"additional_info7": "<string>"
},
"payu": {
"udf1": "<string>",
"udf2": "<string>",
"udf3": "<string>",
"udf4": "<string>"
},
"razorpay": {
"receipt": "<string>",
"notes": {}
},
"zaakpay": {
"extra1": "<string>",
"extra2": "<string>"
}
}
}
]
}
},
"order_status": {
"reference_id": "<string>",
"order": {
"status": "pending",
"type": "<string>",
"catalog_id": "<string>",
"items": [
{
"name": "<string>",
"amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"quantity": 123,
"retailer_id": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sale_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"country_of_origin": "<string>",
"importer_name": "<string>",
"importer_address": "<string>"
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"tax": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"discount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"expiration": {
"timestamp": "1727438564",
"description": "<string>"
},
"description": "<string>"
}
},
"location": {
"latitude": 123,
"longitude": 123,
"name": "<string>",
"address": "<string>"
},
"group_id": "120363345678901234@g.us"
}
],
"cards": [
{
"card_index": 4,
"components": [
{
"type": "header",
"sub_type": "quick_reply",
"index": 4,
"parameters": [
{
"type": "text",
"text": "<string>",
"payload": "<string>",
"coupon_code": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"gif": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"video": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"document": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"limited_time_offer": {
"expiration_time_ms": "1698562800000"
},
"action": {
"thumbnail_product_retailer_id": "2lc20305pt",
"sections": [
{
"title": "<string>",
"product_items": [
{
"product_retailer_id": "<string>"
}
]
}
],
"flow_token": "<string>",
"flow_action_data": {},
"order_details": {
"currency": "<string>",
"order": {
"status": "pending",
"type": "<string>",
"catalog_id": "<string>",
"items": [
{
"name": "<string>",
"amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"quantity": 123,
"retailer_id": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sale_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"country_of_origin": "<string>",
"importer_name": "<string>",
"importer_address": "<string>"
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"tax": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"discount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"expiration": {
"timestamp": "1727438564",
"description": "<string>"
},
"description": "<string>"
},
"reference_id": "<string>",
"total_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"type": "<string>",
"payment_settings": [
{
"type": "payment_gateway",
"payment_gateway": {
"type": "billdesk",
"configuration_name": "<string>",
"billdesk": {
"additional_info1": "<string>",
"additional_info2": "<string>",
"additional_info3": "<string>",
"additional_info4": "<string>",
"additional_info5": "<string>",
"additional_info6": "<string>",
"additional_info7": "<string>"
},
"payu": {
"udf1": "<string>",
"udf2": "<string>",
"udf3": "<string>",
"udf4": "<string>"
},
"razorpay": {
"receipt": "<string>",
"notes": {}
},
"zaakpay": {
"extra1": "<string>",
"extra2": "<string>"
}
}
}
]
}
},
"order_status": {
"reference_id": "<string>",
"order": {
"status": "pending",
"type": "<string>",
"catalog_id": "<string>",
"items": [
{
"name": "<string>",
"amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"quantity": 123,
"retailer_id": "<string>",
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sale_amount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"country_of_origin": "<string>",
"importer_name": "<string>",
"importer_address": "<string>"
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"tax": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"discount": {
"offset": 100,
"value": 1234,
"description": "<string>",
"discount_program_name": "<string>"
},
"expiration": {
"timestamp": "1727438564",
"description": "<string>"
},
"description": "<string>"
}
},
"location": {
"latitude": 123,
"longitude": 123,
"name": "<string>",
"address": "<string>"
},
"group_id": "120363345678901234@g.us"
}
]
}
]
}
]
}
]
},
"text": {
"body": "<string>",
"preview_url": true
},
"image": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"video": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"audio": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"document": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"sticker": {
"id": "<string>",
"link": "<string>",
"caption": "<string>",
"filename": "<string>",
"voice": true
},
"updateTime": "2023-11-07T05:31:56Z",
"sendTime": "2023-11-07T05:31:56Z",
"groupMessageType": "group_marketing",
"groupMemberCount": 123,
"recipientCount": 123,
"sent": 123,
"delivered": 123,
"read": 123,
"failed": 123,
"errorCode": "<string>",
"errorMessage": "<string>",
"totalPrice": 123,
"currency": "USD"
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Authorizations
Path Parameters
ID of the object.
Example:
"627c8640675de8fc689ab9d9"
Response
Successfully retrieved the group message.
One outbound group message. Group-level status is separate from member delivery results.
YCloud group-message ID.
Example:
"wam_group_01"
Sender phone number in E.164 format.
Example:
"+16315551111"
WhatsApp group ID.
Example:
"120363345678901234@g.us"
Available options:
text, image, video, audio, document, sticker, template Group-level send status. accepted means YCloud accepted the request; sent and failed come from the group-level Meta result. expired may be returned when Meta reports expiry, but Group Message Logs filters expose only sent and failed.
Available options:
accepted, sent, failed, expired Available options:
outbound Complete fixed recipient snapshot. Empty when the message failed before a reliable snapshot was obtained.
Show child attributes
Show child attributes
WhatsApp group-level message ID when Meta accepted the request.
Example:
"wamid.HBg..."
Group name captured for the message log.
Example:
"New Purchase Inquiry"
Customer-defined identifier from the send request.
Use for sending a WhatsApp template message.
Show child attributes
Show child attributes
WhatsApp Message Text Object.
Show child attributes
Show child attributes
Use for image, gif, video, audio, document, or sticker messages.
See also Supported Media Types.
Note: Either id or link must be provided, but not both. These parameters are mutually exclusive.
Reference: WhatsApp Cloud API Media Object
Show child attributes
Show child attributes
Use for image, gif, video, audio, document, or sticker messages.
See also Supported Media Types.
Note: Either id or link must be provided, but not both. These parameters are mutually exclusive.
Reference: WhatsApp Cloud API Media Object
Show child attributes
Show child attributes
Use for image, gif, video, audio, document, or sticker messages.
See also Supported Media Types.
Note: Either id or link must be provided, but not both. These parameters are mutually exclusive.
Reference: WhatsApp Cloud API Media Object
Show child attributes
Show child attributes
Use for image, gif, video, audio, document, or sticker messages.
See also Supported Media Types.
Note: Either id or link must be provided, but not both. These parameters are mutually exclusive.
Reference: WhatsApp Cloud API Media Object
Show child attributes
Show child attributes
Use for image, gif, video, audio, document, or sticker messages.
See also Supported Media Types.
Note: Either id or link must be provided, but not both. These parameters are mutually exclusive.
Reference: WhatsApp Cloud API Media Object
Show child attributes
Show child attributes
Present after the group-level status reaches sent.
Group-level business pricing category reported by Meta.
Available options:
group_marketing, group_utility, group_service Total group participant count at send time, including the business sender. Omitted when no reliable snapshot was obtained.
Fixed count of recipient members at send time. Later membership changes do not alter it. Omitted when no reliable snapshot was obtained.
Members currently in sent status.
Members currently in delivered or read status.
Members currently in read status.
Members currently in failed or expired status.
Group-level failure code.
Group-level failure message.
Sum of final member charges when every member charge is known and uses the same currency. Zero is a valid final total.
ISO 4217 currency for totalPrice.
Example:
"USD"