Export SMS událostí přes API

Obsah

This post is also available in:

Pomocí tohoto API můžete získat výpis všech událostí, které se týkají zpracování SMS zprávy. Dotazovat se lze na určitý časový interval <from,to>.

Endpoint URL

V závislosti na vašem účtu zvolte odpovídající URL endpointu.

Pokud se přihlašujete na adrese app.samba.ai –> zvolte URL api.samba.ai
Pokud se přihlašujete na adrese enterprise.samba.ai –> zvolte URL api.yottly.com

Trackpoint ID vašeho účtu naleznete v sekci Nastavení>Přehled.

POST

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

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

trackpointId – Trackpoint ID vašeho e-shopu
your-api-key – API klíč
from, to – [volitelné] timestamp události v milisekundách
- Pokud je parametr from vynechán, tak je automaticky nastaven jako to - 90 dní.
- Pokud je parametr to vynechán, tak je automaticky nastaven jako minimum z now() a from + 90 dní.
- Pokud jsou oba parametry to a from vynechány, tělo požadavku musí být nastaveno na {}. V tomto případě je parametr to automaticky nastaven jako now() a from je nastaven jako now() - 90 days.
- K dispozici je vždy historie maximálně posledních 90 dní.

RESPONSE

formát: JSON stream, jeden json object na řádek (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 Samba účtu
userId: user ID příjemce SMS zprávy
status: jedna z těchto událostí
- DELIVERED, ACCEPTED, EXPIRED, DELETED, UNDELIVERABLE, REJECTED, SKIPPED
date: timestamp v milisekundách kdy došlo k vytvoření události
source: identifikace kampaně
- "type": "one-off" – Jednorázová SMS kampaň
  - campaign id, name
- "type": "flow" – SMS uzel ve Flow kampani
  - campaign id, name
  - node id, name
- sendDate: timestamp v milisekundách kdy byla zpráva odeslána

PŘÍKLAD

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:

Upraveno 5 ledna, 2024

Byl pro vás tento článek užitečný?

Yes No

RESPONSE

PŘÍKLAD

Byl pro vás tento článek užitečný?

Mohlo by vás zajímat