## Tabuľka parametrov spoločná pre všetky metódy (show, add, remove)

```url
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ÁZOV PARAMETRA   | HODNOTA                                          | POVINNÉ | PREDVOLENÁ HODNOTA |
|:------------------|:-------------------------------------------------|:-------:|:---------------:|
| application_id    | [ID aplikácie](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/administracia-api/)       | **Áno** |        -        | 
| application_token | [Overovací token aplikácie](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/api-tokeny/)	 | **Áno** |        -        |
| phone_number      | Telefónne číslo kontaktu                         | **Áno** |        -        |

## Zobraziť súhlas

### API URL (show)
Adresa URL používaná na odosielanie HTTP požiadaviek:
```url
https://portal.bulkgate.com/api/1.0/address-book/agreement/show
```

### Príklad úplnej požiadavky (show)

```http-json
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"
}
```

### Odpoveď na tento príkaz môže byť: (show)

**V prípade úspechu:**
```json
{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "2023-03-30T13:29:15+02:00"
    }
}
```

**V prípade chyby:**
```json
{
    "type": "number_not_found",
    "code": 400,
    "error": "Number not found",
    "detail": null
}
```

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

## Pridať súhlas
> [!NOTE]
> Ak telefónne číslo v adresári neexistuje, bude automaticky pridané.

### API URL (add)
Adresa URL používaná na odosielanie HTTP požiadaviek:
```url
https://portal.bulkgate.com/api/1.0/address-book/agreement/add
```

### Príklad úplnej požiadavky (add)

```http-json
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"
}
```

### Odpoveď na tento príkaz môže byť: (add)

**V prípade úspechu:**
```json
{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "2023-03-30T12:59:26+02:00"
    }
}
```

**V prípade chyby:**

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

## Odstrániť súhlas

### API URL (remove)
Adresa URL používaná na odosielanie HTTP požiadaviek:
```url
https://portal.bulkgate.com/api/1.0/address-book/agreement/remove
```

### Príklad úplnej požiadavky (remove)

```http-json
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"
}
```

### Odpoveď na tento príkaz môže byť: (remove)

**V prípade úspechu:**
```json
{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "null"
    }
}
```

**V prípade chyby:**
```json
{
    "type": "number_not_found",
    "code": 400,
    "error": "Number not found",
    "detail": null
}
```

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