Opt-in souhlas

Tabulka parametrů společná pro všechny metody (show, add, remove)

https://portal.bulkgate.com/api/1.0/address-book/agreement/show https://portal.bulkgate.com/api/1.0/address-book/agreement/add https://portal.bulkgate.com/api/1.0/address-book/agreement/remove

NÁZEV PARAMETRU	HODNOTA	POVINNÉ	VÝCHOZÍ HODNOTA
application_id	ID aplikace	Ano	-
application_token	Ověřovací token aplikace	Ano	-
phone_number	Telefonní číslo kontaktu	Ano	-

Zobrazit souhlas

API URL (show)

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

https://portal.bulkgate.com/api/1.0/address-book/agreement/show

Příklad úplné žádosti (show)

POST /api/1.0/address-book/agreement/show HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "phone_number": "+420777777777" }

Odpověď na tento příkaz může být: (show)

V případě úspěchu:

{ "data": { "phone_number": "+420777777777", "agreement": "2023-03-30T13:29:15+02:00" } }

V případě chyby:

{ "type": "number_not_found", "code": 400, "error": "Number not found", "detail": null }

{ "type": "invalid_phone_mobile", "code": 400, "error": "Invalid phone mobile", "detail": null }

Přidat souhlas

Poznámka

Pokud telefonní číslo v adresáři neexistuje, bude automaticky přidáno.

API URL (add)

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

https://portal.bulkgate.com/api/1.0/address-book/agreement/add

Příklad úplné žádosti (add)

POST /api/1.0/address-book/agreement/add HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "phone_number": "+420777777777" }

Odpověď na tento příkaz může být: (add)

V případě úspěchu:

{ "data": { "phone_number": "+420777777777", "agreement": "2023-03-30T12:59:26+02:00" } }

V případě chyby:

{ "type": "invalid_phone_mobile", "code": 400, "error": "Invalid phone mobile", "detail": null }

Odstranit souhlas

API URL (remove)

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

https://portal.bulkgate.com/api/1.0/address-book/agreement/remove

Příklad úplné žádosti (remove)

POST /api/1.0/address-book/agreement/remove HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "phone_number": "+420777777777" }

Odpověď na tento příkaz může být: (remove)

V případě úspěchu:

{ "data": { "phone_number": "+420777777777", "agreement": "null" } }

V případě chyby:

{ "type": "number_not_found", "code": 400, "error": "Number not found", "detail": null }

{ "type": "invalid_phone_mobile", "code": 400, "error": "Invalid phone mobile", "detail": null }

Byla tato stránka užitečná?

Zeptat se AI Zkopírováno