Wooxy API v.3.0

Send Batch Triggered Web Push

The Send Batch Triggered Web Push method allows sending bulk Web Push notifications to contacts added to our system and saved in a specific list, but no more than 100 contacts at a time. The Web Push notifications are sent from the domain where the list was created, using templates previously created and saved within our system.

IMPORTANT: In a single request, you can send communications to no more than 100 contacts at once.

Request

POST

https://api.wooxy.com/v3/web-push/batch

IMPORTANT: Do not send more than 10 concurrent API requests.

Body Example

                                        {
            "templateId": "YOUR_TEMPLATE_ID",
            "contactListId": "YOUR_CONTACT_LIST_ID",
            "contacts": [
                {
                    "contact": "contact1Identifier",
                    "variables": [
                        {
                            "name": "contactVar",
                            "value": "contactVarValue"
                        }
                    ]
                },
                {
                    "contact": "contact2Identifier"
                },
                {
                    "contact": "contact3Identifier"
                }
            ],
            "variables": [
                {
                    "name": "templateVar",
                    "value": "templateVarValue"
                }
            ],
            "tag": [
                "YOUR_BATCH_TAGS",
            ],
            "device": "all",
            "ttl": 3600,
        }

Parameters

Title	Type	Default	Description
contactListId required	string		ID of the contact list which the contact belongs to. The list should be already created in your account on Lists page: https://app.wooxy.com/email-list
contacts required	array		An array of objects that includes the contacts identifiers to which the messages will be sent, as well as an array of objects with unique variables for each contact.
contacts.contact required	string		The `'email'` address, `'userId'` or `'phoneNumber'` of the recipient stored in corresponding contactList.
contacts.variables optional	array		An array of unique variables for each contact. Please, take in account variables usage priorities is case of conflicting variables: `First Priority`: Variable from API request; `Second Priority`: Variable from the Content Custom Variables; `Third Priority`: Variable from the selected list. Important! Variables passed to the contact have the highest priority when used in the template.
contacts.variables.name required	string		The name of the contact's unique variable. `WARNING:` Please use only latin `lowerCamelCase` format. No numbers or other symbols allowed.
contacts.variables.value required	string\|integer\|boolean		The value of the contact's unique variable. Variable value in `'ENUM_STRING'` or `'ENUM_DATE'` format correspondingly.
templateId required	string		The Push template you want to send. The template should be already created in your account on the Templates page: https://app.wooxy.com/templates
tags optional	array		An array of strings that can be used to tag a message. Statistics are accumulated using tags, and the number of tags available depends on the plan. All tags you want to use must be created in advance on the platform in the tags section. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.
variables optional	array		An array of common variables that will be applied to the sending for each individual recipient. Please, take in account variables usage priorities is case of conflicting variables: `First Priority`: Variable from API request; `Second Priority`: Variable from the Content Custom Variables; `Third Priority`: Variable from the selected list.
variables.name required	string		The name of the variable that will be applied in the template for each contact. `WARNING:` Please use only latin `lowerCamelCase` format. No numbers or other symbols allowed.
variables.value required	string\|integer\|boolean		The value of the variable that will be applied in the template for each contact. Variable value in `'ENUM_STRING'` or `'ENUM_DATE'` format correspondingly.
device optional	string		Add kinds of browsers to the parameter. Available options. `Important:`By default, we send to both browsers: desktop: Notifications will only be shown on the desktop version of the browser; mobile: Notifications will only be shown on the mobile version of the browser.
ttl optional	integer	3600	Time to live must be specified in seconds. Between 30 minutes to 72 hours.

Response

                                        {
  "result": true,
  "success": {
    "contactIdentifier": "Message ID"
  },
  "failed": {
    "contactIdentifier": "Error description"
  }
}

Parameters

Title	Type	Description
result	boolean	Indicated that the query was successful or not: true: The value indicates that the query was successful. false: The value indicates that the query wasn't successful.
success	object	An object containing all successful sends, including the contacts identifiers to whom the emails were sent and the `messageId` of each send.
success.contactIdentifier	string	The identifiers of the contact to whom the successful send was made.
success[messageId]	string	The Message ID of a successful send to a specific contact.
failed	object	An object with failed sends, including the contact identifiers that could not receive the communication and the reason why the send was unsuccessful.
failed.contactIdentifier	string	The identifiers of the contact to whom the communication could not be sent.
failed[error]	string	The error that prevented the sending to a specific contact.

Method Errors

                                        {
  "result": false,
  "errors": [
    "Error description"
  ]
}

Error
"Argument contactListId must be a string"
"Argument contactListId must be a non-empty string"
"Contact list with id {contactListId} not found"
"Each contact must contain contact field"
"Argument contacts must be an array of objects"
"Amount of contacts must be less or equal 100"
"Duplicated as {contact}"
"Contact not found"
"name of variable can not be empty"
"Argument templateId must be a non-empty string"
"Template with id {templateId} not found"
"Argument tags must be an array"
"Tag name must be a non-empty string"
"Tags should be 50 characters or less"
"Any tags starting with an underscore are reserved for internal use and will cause errors"
"Tag %s is not registered in account tags"
"Argument variables must be an array of arrays with \"name\" and \"value\" fields"
"name of variable must be a string"
"variable \"{name}\" is reserved and can not be added as custom variable"
"invalid name of variable {name}"
"Payment required"
"Fail to publish message"
"No contacts to handle"
"Twig syntax error: {error}"
"Invalid authorization token!"
"Internal server error"
"Bad Request"
"no matches found for access token {accessToken}"
"user {id} not enabled"
"no data found for key {userId}"
"access token check failed for key/secret $key/$accessToken"
"Argument {argument} required"
"Web push subscription not found"
"Not found any active web push subscriptions"
"You dont have any websites on list {contactListId}"
"Contact is not subscribed to web push"
"Argument ttl must be a numeric"
"Argument ttl must be between 30 minutes and 72 hours reproduced by seconds value"
"Argument device must be a non-empty string"
"Argument device must be in [desktop, mobile]"
"Contact is not active"
"Argument ttl must be between 30 minutes and 72 hours (expressed in seconds)"
"You don't have any websites on the list {contactListId}"

Code Examples

PHP

                $accessToken = 'Your API Key'; 
$url  = 'https://api.wooxy.com/v3/web-push/batch';

$body = json_encode([
    'templateId' => 'YOUR_TEMPLATE_ID',
    'contactListId' => 'YOUR_CONTACT_LIST_ID',
    'contacts' => [
        [
            'contact' => 'contact1Identifier',
            'variables' => [
                [
                    'name' => 'contactVar',
                    'value' => 'contactVarValue'
                ]
            ]
        ],
        [
            'contact' => 'contact2Identifier'
        ],
        [
            'contact' => 'contact3Identifier'
        ]
    ],
    'variables' => [
        [
            'name' => 'templateVar',
            'value' => 'templateVarValue'
        ]
    ],
    'tag' => [
        'YOUR_BATCH_TAGS',
    ],
    'device' => 'all',
    'senderId' => 'YOUR_SENDER_ID',
    'ttl' => 3600,
]);

/** * Request Example */
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_INFILESIZE, null);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Access-Token: $accessToken",
    'Content-Type: application/json',
    'Content-Length: ' . strlen($body),
]);

$result = curl_exec($ch);
if ($result === false) {
    echo 'cURL error:' . curl_error($ch) . PHP_EOL;
} else {
    echo strval($result) . PHP_EOL;
}
curl_close($ch);