## Tabulka parametrů společná pro všechny metody (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ÁZEV PARAMETRU   | HODNOTA                                          | POVINNÉ | VÝCHOZÍ HODNOTA |
|:------------------|:-------------------------------------------------|:-------:|:---------------:|
| application_id    | [ID aplikace](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/administrace-api/)       | **Ano** |        -        | 
| application_token | [Ověřovací token aplikace](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/api-tokeny/)	 | **Ano** |        -        |
| phone_number      | Telefonní číslo kontaktu                         | **Ano** |        -        |

## Zobrazit souhlas

### API URL (show)
Adresa URL používaná k odesílání požadavků HTTP:
```url
https://portal.bulkgate.com/api/1.0/address-book/agreement/show
```

### Příklad úplné žádosti (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"
}
```

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

**V případě úspěchu:**
```json
{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "2023-03-30T13:29:15+02:00"
    }
}
```

**V případě 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
}
```

## Přidat souhlas
> [!NOTE]
> 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:
```url
https://portal.bulkgate.com/api/1.0/address-book/agreement/add
```

### Příklad úplné žádosti (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"
}
```

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

**V případě úspěchu:**
```json
{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "2023-03-30T12:59:26+02:00"
    }
}
```

**V případě chyby:**

```json
{
    "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:
```url
https://portal.bulkgate.com/api/1.0/address-book/agreement/remove
```

### Příklad úplné žádosti (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"
}
```

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

**V případě úspěchu:**
```json
{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "null"
    }
}
```

**V případě 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
}
```