You can send one or multiple SMS with a single JSON request to the sending endpoint.

The server will return a JSON, with a boolean success if the send request was processed successfully.

Additionally, in the JSON, the list of SMS sent will be returned, with a success parameter indicating whether that particular message could be processed or not.

Each message also has an sms_id code that identifies that specific SMS. This code is used later in sending status reports.

As in the rest of the requests to ZPK Systems APIS, a cost parameter is provided indicating the total cost of the request to the API

Example of response with correct submission.

{
   "success": true,
   "messages": [
      {
         "from": "Sender Here",
         "phone": "+34 000000",
         "message": "The message",
         "success": true,
         "sms_id": "f205d6e838ec4110992a4a871a74d279"
      }
   ],
   "cost": 0.02485
}
				

Example answer with some incorrect messages.

Example with a successful request, which however contained one incorrect destination number.

{
   "success": true,
   "messages": [
      {
         "from": "Sender here",
         "phone": "+34 000000",
         "message": "The message",
         "success": true,
         "sms_id": "f205d6e838ec4110992a4a871a74d279"
      },
      {
         "from": "Sender here",
         "phone": "NotValidPhone",
         "message": "El mensaje a enviar...",
         "success": false,
         "sms_id": "",
         "error_id": "INVALID_DESTINATION",
         "error_msg": "SMS parameter 'to' must be a number in international format, between 7 and 15 digits."
      }
   ],
   "cost": 0.02485
}
				

Example response with general error

{
   "success": false,
   "errors": [
      {
         "id": "INVALID_PARAMETER",
         "message": "Messages array is empty.",
		 "on": "messages"
      }
	]
}
				

Response JSON

{
   "success": true,
   "prices": [
      {
         "country_code": "AB",
         "prefix": "7",
         "network_name": "Other",
         "price": 0.0652
      },
      {
         "country_code": "AB",
         "prefix": "7",
         "network_name": "Aquafon",
         "price": 0.0652
      },
      {
         "mas tarifas": "...."
      }
	],
   "cost": 0.02485

}

Requesting callback

If the callback_url parameter is established when making a sending request, ZPK will send a status report to the url of the server indicating the status of sending SMS when it has information from the operator.

This response may take anywhere from a few seconds to 48 hours, depending on the destination operator.

First we specify the callback url at the time of requesting the sending of messages.

{
	"application_id": "app234234",
	"api_key": "DSFJnn3JLdfdfs",
	"callback_url": "https://miservidor.com/zpk_sms_callback",
	"messages":[
		{
			"from": "TEST",
			"phone": "600568046",
			"message": "Test de envío con callback"
		}
	]
}

Receiving callbacks

When the SMS is delivered or rejected by the operator, ZPK will send a JSON notification to your server containing an array of delivery statuses.

[
	{
		"sms_id":"537b7194d5804ad9b1afead36f3d5e16",
		"from":"YourName",
		"phone":"+34600000000",
		"message":"message to send",
		"generated_at":"2023-07-16 06:59:49",
		"status":"delivered",
		"delivered_at":"2023-07-16 06:59:59"
	}
]

Your server should respond with an HTTP/200 code, any other code will be interpreted as a temporary error on your server, and ZPK will retry the notification every 25 minutes for up to 56 hours.

SDK in PHP to send text messages.

ZPK-PHP is an open source composer-installable library that will allow you to integrate our APIs into your PHP project with minimal effort.

Installation

composer require zpksystems/phpzpk

Example request

<?php

$smsRequest = new zpkSMS( new zpkApplication('appid','key') );

// Add SMS
$sms = new ZpkSms('+34600000000');
$sms->setMessage("Test SMS message");

$smsRequest->addSMS($sms);


// Add SMS with custom reference

$sms = new ZpkSms('+34600000000');
$sms->setMessage("Test SMS message");
$sms->setReference('my-reference');

$smsRequest->addSMS($sms);

// Send
$smsRequest->send();