Ricevuta di consegna

GET /api/rest/v1/sms/delivery.[json|xml]

Filtri

Parametro	Tipo	Default	Descrizione	Solo rivenditori
limit	number	100	Limita il numero di risultati. Max: 1000
offset	number	0	Offset per la paginazione
queue_id	string		Id della spedizione. Vedi note 1
sending_batch_id	string		Id batch di spedizione. Vedi note 2
delivery_status	enum		Vedi dettagli suo campi
from_date	date		Data in formato YYYY-MM-DD
user_id	string		Id subaccount. Vedi note 3	Sì

Note:

• 1 Id della spedizione ottenuto con la chiamata Invio SMS. Spesso nominato anche come idt o sending_id
• 2 Id del batch (sending_batch_id) ottenuto con la chiamata Spedizioni in Batch.
• 3 Id del subaccount. Solo rivenditori, ignorato per utenti diversi da rivenditori. Vedi Lista subaccounts

danger

Puoi specificare solo uno dei seguenti filtri: queue_id, sending_batch_id, from_date

Esempio di risposta

{
    "count": 19,
    "limit": 2,
    "offset": 0,
    "deliveries": [
        {
            "user_id": "2",
            "queue_id": "22340688074951135",
            "sender": "mittente",
            "receiver": "+393801234567",
            "delivery_date": "2022-12-07 16:32:00",
            "delivery_status": "DELIVERED",
            "reason_code": null
        },
        {
            "user_id": "2",
            "queue_id": "22340600235226183",
            "sender": "mittente",
            "receiver": "+393801234567",
            "delivery_date": "2022-12-07 14:25:03",
            "delivery_status": "NOT_DELIVERED",
            "reason_code": "997"
        }
    ]
}

Dettagli sui campi

Field	Type	Null
delivery_date	datetime	YES
delivery_status	enum('DELIVERED','NOT_DELIVERED','LOST_NOTIFICATION','BUFFERED','ERROR','UNKNOWN','SUBSCRIBER_UNKNOWN')	YES
reason_code	char(3)	YES

Esempi pratici

Bash (cURL)

curl --location 'https://v2.smsviainternet.it/api/rest/v1/sms/delivery.json?limit=2&from_date=2022-12-07' \
--header 'X-Api-Token: MyToken' \
--data ''

Go Lang

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://v2.smsviainternet.it/api/rest/v1/sms/delivery.json?limit=2&from_date=2022-12-07"
  method := "GET"

  payload := strings.NewReader(``)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-Api-Token", "MyToken")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://v2.smsviainternet.it/api/rest/v1/sms/delivery.json?limit=2&from_date=2022-12-07',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'X-Api-Token: MyToken'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Javascript (NodeJS+request)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://v2.smsviainternet.it/api/rest/v1/sms/delivery.json?limit=2&from_date=2022-12-07',
  'headers': {
    'X-Api-Token': 'MyToken'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});