Eksport zdarzeń SMS przez API

Spis treści

This post is also available in:

Za pomocą tego interfejsu API można uzyskać listę wszystkich zdarzeń związanych z przetwarzaniem wiadomości SMS. Możesz zapytać o określony przedział czasu <from,to> w którym zdarzenie powinno wystąpić.

Punkt końcowy URL

W zależności od konta wybierz odpowiedni adres URL punktu końcowego.

Jeśli logujesz się na app.samba.ai –> wybierz adres URL api.samba.ai
Jeśli logujesz się na stronie enterprise.samba.ai –> wybierz adres URL api.yottly.com

Identyfikator Trackpoint ID można znaleźć w sekcji Ustawienia > Przegląd.

POST

https://api.samba.ai/shop/trackpointId/export-sms-events

header: X-Api-Key: your-api-key
{"from": timestamp, "to": timestamp}

trackpointId – Trackpoint ID konta Samba
your-api-key – Klucz API Samba dla sklepu internetowego
from, to – [opcjonalnie] znacznik czasu zdarzenia w milisekundach
- Jeśli parametr from zostanie pominięty, zostanie on automatycznie ustawiony to - 90 days.
- Jeśli parametr to zostanie pominięty, zostanie on automatycznie ustawiony na minimum z now() i from + 90 days.
- Jeśli pominięto parametry to i from treść żądania musi być ustawiona na {}. W tym przypadku to jest automatycznie ustawiane na now() a from jest ustawiane na now() - 90 days.
- Historia z ostatnich 90 dni jest zawsze dostępna.

RESPONSE

format: Strumień JSON, jeden obiekt json na linię (application/json-seq)

{
  "smsEvent":{
     "trackpoint": trackpointId,
     "userId": "user id",
     "status": "STATUS", 
     "date": 1654853160310
   }, 
  "source":{
     "type":"flow", 
     "campaign":{
        "id": "campaignId",
        "name": "campaignName"
     },
     "node":{
        "id": "nodeId",
        "name": "nodenName"
     },
     "sendDate":1654853160010 
  }
}

trackpoint: Trackpoint ID konta Samba
userId: ID użytkownika odbiorcy wiadomości SMS
status: Jedno z tych wydarzeń
- DOSTARCZONE, ZAAKCEPTOWANE, WYGASŁE, USUNIĘTE, NIEDORĘCZALNE, ODRZUCONE, POMINIĘTE
date: znacznik czasu w milisekundach, kiedy zdarzenie miało miejsce
source: identyfikacja kampanii
- "type": "one-off" – Jednorazowa kampania SMS
  - identyfikator kampanii, nazwa
- "type": "flow" – Węzeł SMS w kampanii Flow
  - identyfikator kampanii, nazwa
  - id węzła, nazwa
- sendDate: znacznik czasu w milisekundach, kiedy wiadomość została wysłana

Przykład

curl  -d '{"from": 1673617501000, "to": 1676380261000}' -H 'X-Api-Key: key' 'https://api.samba.ai/shop/4541245641234564/export-sms-events'

{
  "smsEvent":{
     "trackpoint": 4541245641234564,
     "userId": "123456",
     "status": "DELIVERED", 
     "date": 1673763160310
  }, 
  "source":{
     "type":"one-off", 
     "campaign":{
        "id": "b2c8c642-ad39-11ed-afa1-0242ac120002",
        "name": "Black Friday"
     },
     "sendDate":1673763160010 
  }
}
{
  "smsEvent":{
     "trackpoint": 4541245641234564,
     "userId": "123456",
     "status": "DELIVERED", 
     "date": 1673753160310
  }, 
  "source":{
     "type":"flow", 
     "campaign":{
        "id": "cd434c68-ad39-11ed-afa1-0242ac120002",
        "name": "Retention"
     },
     "node":{
        "id": "32411fb4-ad3a-11ed-afa1-0242ac120002",
        "name": "Retention VIP SMS"
     },
     "sendDate":1673753160010 
  }
}

This post is also available in:

Zaktualizowano na 5 maja, 2025

Czy ten artykuł był pomocny?

Yes No

RESPONSE

Przykład

Czy ten artykuł był pomocny?

Artykuły powiązane