Enables document sharing. type value is 14.
{
"txnid": "134434",
"receiver": {
"type": 2,
"address": "9053XXXXXXXX"
},
"composition": {
"list": [{
"type": 14,
"document": {
"filename": "test",
"filepath": "https://tvoip.turkcell.com.tr/URL"
}
}]
}
} | Field | Value | Description |
|---|---|---|
| *txnid | string | Request id value |
| *receiver | object | |
| *type | int | Recipient address type. Values: 0 -> Hashed address 1 -> All addresses following the service 2 -> MSISDN (plain number) |
| *address | string | Address in the type specified by type. If type is 0, address is hashed (value provided by bipussu). If type is 1, address must not be in the request. If type is 2, provide the address in 905XXXXXXXXX format. |
| *composition | object | |
| *list | list | Messages to send; at least 1 item required. |
| *type | int | Message type. Values: 0 – Text 2 – Photo 3 – Audio 4 – Video 5 – Sticker 6 – Caps 7 – Location 9 – Finish Line 10 – Contact 13 – Template Media Message 14 – Document. |
| *document | object | Document payload |
| *filename | string | File name. If omitted, filename is derived from filepath. |
| *filepath | string | File URL uploaded to FTS |
document cannot be null or empty. [1070]filepath cannot be null or empty. Must be a URL obtained via the FTS API; max length 512 characters. [1070]filename is omitted, the file name is derived from the URL. If that is empty, an error is returned. [1070]| resultcode | Description |
|---|---|
| 1070 | invalid document |