Specifikace · BulkGate Helpdesk

API URL

Adresa URL používaná k odeslání požadavků HTTP:

https://portal.bulkgate.com/api/1.0/simple/promotional

Podporované HTTP metody

Tabulka s parametry

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
application_id	Aplikační identifikátor	Ano	-
application_token	Aplikační ověřovací token	Ano	-
number	Čísla příjemců oddělená `;` (středníkem)	Ano	-
text	Text SMS zprávy (max. 612 znaků nebo 268 znaků, jestliže je aktivován Unicode), UTF-8 kódování	Ano	-
unicode	`Yes`/`true`/`1` pro Unicode SMS, no/false/0 pro 7bit SMS	Ne	`false`
sender_id	ID odesílatele, viz typ ID odesílatele	Ne	`gSystem`
sender_id_value	Hodnota odesílatele - `gOwn` (např. "420 777 777 777"), `gText` (např. "BulkGate"), `gProfile` (např. "423"), `gMobile` or `gPush` (KEY)	Ne	`null`
country	Poskytněte čísla příjemců v mezinárodním formátu (s prefixem, např. `420`) nebo přidejte kód země (`775123456` + `CZ` = `420775123456`). Podívejte se na příklad požadavku země. Pokud je hodnota `null,` poté se použije vaše nastavená časová zóna pro doplnění informace	Ne	`null`
schedule	Naplánujte čas a datum odesílání v unix timestamp, nebo ISO 8601. Podívejte se na níže uvedené příklady	Ne	Nyní
duplicates_check	Zvolte možnost `on`, chcete-li zabránit odesílání duplicitních zpráv na stejné telefonní číslo. Zprávy se stejným textem zaslaným na stejné číslo budou odstraněny. Pokud je aktivní možnost `off`, žádné duplikáty nebudou odstraněny.	Ne	`null`
tag	Označení zpráv pro následné dohledání uživatele.	Ne	-

Typ ID odesílatele `sender_id`

HODNOTA	VÝZNAM
`gSystem`	Systémové číslo
`gShort`	Short Code
`gText`	Textový odesílatel
`gMobile`	Mobile Connect
`gPush`	Mobile Connect push - Odešle notifikaci do vaší Mobile Connect aplikace
`gOwn`	Vlastní číslo (vyžaduje ověření čísla)
`gProfile`	BulkGate Profil ID
`<int>`	BulkGate Profil ID

Příklad úplného požadavku:

https://portal.bulkgate.com/api/1.0/simple/promotional
    ?application_id=<APPLICATION_ID>
    &application_token=<APPLICATION_TOKEN>
    &number=420777777777;420775123456;606123456
    &text=test_sms
    &unicode=yes
    &sender_id=gText
    &sender_id_value=BulkGate
    &country=cz
    &schedule=2018-05-14T18:30:00-01:00

Příklad požadavku země:

https://portal.bulkgate.com/api/1.0/simple/promotional
    ?application_id=<APPLICATION_ID>
    &application_token=<APPLICATION_TOKEN>
    &number=606123456;420777777777
    &text=test_sms
    &country=gb

Příklad požadavku ISO 8601:

https://portal.bulkgate.com/api/1.0/simple/promotional
    ?application_id=<APPLICATION_ID>
    &application_token=<APPLICATION_TOKEN>
    &number=420775123456;420606123456
    &text=test_sms
    &schedule=2018-05-14T18:30:00-01:00

Příklad požadavku unix timestamp:

https://portal.bulkgate.com/api/1.0/simple/promotional
    ?application_id=<APPLICATION_ID>
    &application_token=<APPLICATION_TOKEN>
    &number=420775123456;420606123456
    &text=test_sms
    &schedule=1526992636

Odpovědí na tuto akci může být:

V případě úspěchu:

{
  "data": {
    "total": {
      "status": {
        "sent": 0,
        "accepted": 0,
        "scheduled": 2,
        "error": 1
      }
    },
    "response": [
      {
        "status": "scheduled",
        "sms_id": "idfkvqrp-0",
        "part_id": [
                    "idfkvqrp-0_1",
                    "idfkvqrp-0_2",
                    "idfkvqrp-0"
                ],
        "number": "420775123456"
      },
      {
        "status": "scheduled",
        "sms_id": "idfkvqrr-1",
        "part_id": [
                    "idfkvqrr-1_1",
                    "idfkvqrr-1_2",
                    "idfkvqrr-1"
                ],
        "number": "420606123456"
      },
      {
        "status": "error",
        "code": 9,
        "error": "Invalid phone number",
        "number": "44771447678"
      }
    ]
  }
}

Kde:

part_ID je pole ID částí původní dlouhé zprávy, která byla rozdělena, protože nesplňovala limit 160 znaků pro jednu zprávu. Více info zde.

V případě chyby:

{
    "type": "invalid_phone_number",
    "code": 400,
    "error": "Neplatné číslo",
    "detail": null
}

{
    "type": "unknown_identity",
    "code": 401,
    "error": "Neznámá identita / neautorizovaná / prázdná application_id",
    "detail": null
}

Kde:

type a error (popisek erroru) můžete vidět v tabulce typů errorů,
code představuje http error
detail je dodatečná informace o erroru

Všechny typy errorů pro Simple API a Advanced API můžete najít zde.

API URL

Podporované HTTP metody

Tabulka s parametry

Typ ID odesílatele sender_id

Typ ID odesílatele `sender_id`