example_job.json

{
    "name": "Whatsapp News Send",
    "tags": [
        "news",
        "de",
        "2022-10-01"
    ],
    "definition": {
        "type": "segmentation-job",
        "recipients": {
            "include": [
                {
                    "id": "[LIST-ID]",
                    "type": "list"
                }
            ]
        },
        "segmentations": [
            {
                "recipient": {
                    "correlation_id": "{{item.phoneNumber}}"
                },
                "condition": {
                    "expression": "item.subscribed == true && item.interests.includes('politics')"
                },
                "action_call": {
                    "action_ref": {
                        "type": "action",
                        "id": "{{segmentSportsSendWhatsappActionId}}"
                    },
                    "parameters": [
                        {
                            "name": "message",
                            "value": "{{ template.custom }}"
                        },
                        {
                            "name": "message_type",
                            "value": "{{ template.message_type }}"
                        },
                        {
                            "name": "toNumber",
                            "value": "{{ item.phoneNumber }}"
                        }
                    ]
                },
                "name": "Daily Deals Test 1",
                "description": "This is a test #1",
                "template": {
                    "message_type": "custom",
                     "custom": {
                        "type": "template",
                        "template": {
                            "namespace": "whatsapp_namespace_id",
                            "name": "whatsapp_news_template_name",
                            "language": {
                                "policy": "deterministic",
                                "code": "de"
                            },
                            "components": [
                        {
                            "type": "header",
                            "parameters": [
                                {
                                    "type": "image",
                                    "image": {
                                        "link": "https://media1.faz.net/ppmedia/aktuell/1039690016/1.7599119/default-retina/kanzlerin-angela-merkel.jpg"
                                    }
                                }
                            ]
                        },
                        {
                            "type": "body",
                            "parameters": [
                                {
                                    "type": "text",
                                    "text": "Breaking: *Ex Chancellor chillign hard*"
                                },
                                {
                                    "type": "text",
                                    "text": "We all knew Angie likes to keep things secret, but this is crazy. Click the link to find out more..."
                                }
                            ]
                        },
                        {
                            "type": "button",
                            "sub_type": "url",
                            "index": 0,
                            "parameters": [
                                {
                                    "type": "text",
                                    "text": "/2022/10/01/headlines/angie-merkel-parties-hard"
                                }
                            ]
                        }
                    ],
                        }
                    }
                }
            }
        ],
        "events_handler": {
            "matching_strategy": "match-first",
            "matchers": [
                {
                    "condition": {
                        "expression": "event.text?.toLowerCase().includes('stop')"
                    },
                    "recipient": {
                        "correlation_id": "{{event.from}}"
                    },
                    "name": "opt-out",
                    "description": "unsubscribe",
                    "action_call": {
                        "action_ref": {
                            "type": "action",
                            "id": "{{unsubscribeActionID}}"
                        },
                        "parameters": [
                            {
                                "name": "action",
                                "value": "unsubscribe"
                            },
                            {
                                "name": "to",
                                "value": "{{event.to}}"
                            },
                            {
                                "name": "from",
                                "value": "{{event.from}}"
                            },
                            {
                                "name": "message_uuid",
                                "value": "{{event.message_uuid}}"
                            },
                            {
                                "name": "message",
                                "value": "message is in the 'action'"
                            }
                        ]
                    }
                },
                {
                    "condition": {
                        "expression": "event_type==='recipient-response'"
                    },
                    "recipient": {
                        "correlation_id": "{{event.from}}"
                    },
                    "name": "ready to engage",
                    "description": "start interaction",
                    "action_call": {
                        "action_ref": {
                            "type": "action",
                            "id": "{{responseProcessingActionId}}"
                        },
                        "parameters": [
                            {
                                "name": "action",
                                "value": "{{event.text}}"
                            },
                            {
                                "name": "to",
                                "value": "{{event.to}}"
                            },
                            {
                                "name": "from",
                                "value": "{{event.from}}"
                            },
                            {
                                "name": "message_uuid",
                                "value": "{{event.message_uuid}}"
                            },
                            {
                                "name": "message",
                                "value": "message is in the 'action'"
                            }
                        ]
                    }
                }
            ]
        }
    }
}

example_list.json

{
    "name": "News Subscribers",
    "labels": [
        {
            "name": "phoneNumber"
        },
        {
            "name": "interests"
        },
        {
            "name": "subscribed",
            "required": true
        }
    ],
    "tags": [
        "news",
        "de",
    ]
}