Download OpenAPI specification:Download
The Threema Broadcast API is designed to let third-party applications communicate with Threema Broadcast identities.
X-API-Key, which can be created here:X-API-Key HTTP header must be sent to indicate which API key is to be used with the request.429 if the request limit is reached.pageSize < 0 or > 5000 will abort the request and return code 400.Return the list of all Broadcast identities
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Identity) [ items <application/json > ] Identity list |
{- "identities": [
- {
- "id": "xxyyzz0099",
- "threemaId": "*BC00001",
- "validUntil": "2018-02-28T22:20:04+0100",
- "type": "o500",
- "recipientLimit": 500
}, - {
- "id": "pw5oa30xpl",
- "threemaId": "*BC00002",
- "validUntil": "2018-02-28T22:20:04+0100",
- "type": "unlimited",
- "recipientLimit": null
}
]
}Return details of the given Broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BroadcastUid) = 10 characters Uid of the Broadcast identity |
| threemaId | string Threema ID of the Broadcast identity |
| validUntil | string <date-time> Period of validity of the Broadcast identity
*Format: iso8601
*Example: |
| type | string Enum: "o15" "o50" "o100" "o500" "o1000" "unlimited" "custom" Identity type |
| recipientLimit | integer Maximum number of recipients |
| nickname | string Name for your Broadcast ID. This name will show up on the recipients’ end when you send them a message. |
| description | string Description for your Broadcast ID. This description is not used anywhere and only exists as an internal notes field. |
| private | boolean If the Private Broadcast is enabled, its contents are only accessible to specified recipients. By disabling this setting the Broadcast becomes public: anyone who knows the Broadcast ID can use bots and subscribe to feeds. |
object (PrivateBroadcastMessageTranslation) Automatic response to users who don’t have access to the private Broadcast. All translated messages (Max. 3500 bytes per message). | |
object (InvalidCommandMessageTranslation) This text will be returned if users enter an invalid command. All translated messages (Max. 3500 bytes per message). | |
object (SwitchLanguageMessageTranslation) This text will be returned after users switch languages. All translated messages (Max. 3500 bytes per message). |
{- "id": "xxyyzz0099",
- "threemaId": "*BC00001",
- "validUntil": "2018-02-28T22:20:04+0100",
- "type": "o500",
- "recipientLimit": 500,
- "nickname": "Nick Name",
- "description": "Used by the sales departement",
- "private": true,
- "privateMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "invalidCommandMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "switchLanguageMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Update the details of the given Broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| nickname required | string [ 1 .. 32 ] characters Name for your Broadcast ID. This name will show up on the recipients’ end when you send them a message. |
| description | string Description for your Broadcast ID. This description is not used anywhere and only exists as an internal notes field. |
| private | boolean If the Private Broadcast is enabled, its contents are only accessible to specified recipients. By disabling this setting the Broadcast becomes public: anyone who knows the Broadcast ID can use bots and subscribe to feeds. |
object (PrivateBroadcastMessageTranslation) Automatic response to users who don’t have access to the private Broadcast. All translated messages (Max. 3500 bytes per message). | |
object (InvalidCommandMessageTranslation) This text will be returned if users enter an invalid command. All translated messages (Max. 3500 bytes per message). | |
object (SwitchLanguageMessageTranslation) This text will be returned after users switch languages. All translated messages (Max. 3500 bytes per message). |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BroadcastUid) = 10 characters Uid of the Broadcast identity |
| threemaId | string Threema ID of the Broadcast identity |
| validUntil | string <date-time> Period of validity of the Broadcast identity
*Format: iso8601
*Example: |
| type | string Enum: "o15" "o50" "o100" "o500" "o1000" "unlimited" "custom" Identity type |
| recipientLimit | integer Maximum number of recipients |
| nickname | string Name for your Broadcast ID. This name will show up on the recipients’ end when you send them a message. |
| description | string Description for your Broadcast ID. This description is not used anywhere and only exists as an internal notes field. |
| private | boolean If the Private Broadcast is enabled, its contents are only accessible to specified recipients. By disabling this setting the Broadcast becomes public: anyone who knows the Broadcast ID can use bots and subscribe to feeds. |
object (PrivateBroadcastMessageTranslation) Automatic response to users who don’t have access to the private Broadcast. All translated messages (Max. 3500 bytes per message). | |
object (InvalidCommandMessageTranslation) This text will be returned if users enter an invalid command. All translated messages (Max. 3500 bytes per message). | |
object (SwitchLanguageMessageTranslation) This text will be returned after users switch languages. All translated messages (Max. 3500 bytes per message). |
{- "nickname": "Nick Name",
- "description": "Used by the sales departement",
- "private": true,
- "privateMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "invalidCommandMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "switchLanguageMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}{- "id": "xxyyzz0099",
- "threemaId": "*BC00001",
- "validUntil": "2018-02-28T22:20:04+0100",
- "type": "o500",
- "recipientLimit": 500,
- "nickname": "Nick Name",
- "description": "Used by the sales departement",
- "private": true,
- "privateMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "invalidCommandMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "switchLanguageMessage": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Return base64 encoded jpeg / png image or null
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| avatar | string or null base64 encoded jpeg / png group image |
{- "_links": [
], - "avatar": "/9j/4AAQSkZJRgABAQAAAQABAAD//gAfQ29tcHJlc3NlZCBieSBqcGVnLXJlY29tcHJlc3P/2wCEAAQEBAQEBAQEBAQGBgUGBggHBwcHCAwJCQkJCQwTDA4MDA4MExEUEA8QFBEeFxUVFx4iHRsdIiolJSo0MjRERFwBBAQEBAQEBAQEBAYGBQYGCAcHBwcIDAkJCQkJDBMMDgwMDgwTERQQDxAUER4XFRUXHiIdGx0iKiUlKjQyNEREXP/CABEIAAEAAQMBIgACEQEDEQH/xAAUAAEAAAAAAAAAAAAAAAAAAAAH/9oACAEBAAAAAEL/xAAUAQEAAAAAAAAAAAAAAAAAAAAI/9oACAECEAAAACj/AP/EABQBAQAAAAAAAAAAAAAAAAAAAAj/2gAIAQMQAAAAJ/8A/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAgEBPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAwEBPwB//9k="
}Update Identity Avatar image
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| avatar required | string base 64 encoded jpeg /png image |
{- "avatar": "/9j/4AAQSkZJRgABAQAAAQABAAD//gAfQ29tcHJlc3NlZCBieSBqcGVnLXJlY29tcHJlc3P/2wCEAAQEBAQEBAQEBAQGBgUGBggHBwcHCAwJCQkJCQwTDA4MDA4MExEUEA8QFBEeFxUVFx4iHRsdIiolJSo0MjRERFwBBAQEBAQEBAQEBAYGBQYGCAcHBwcIDAkJCQkJDBMMDgwMDgwTERQQDxAUER4XFRUXHiIdGx0iKiUlKjQyNEREXP/CABEIAAEAAQMBIgACEQEDEQH/xAAUAAEAAAAAAAAAAAAAAAAAAAAH/9oACAEBAAAAAEL/xAAUAQEAAAAAAAAAAAAAAAAAAAAI/9oACAECEAAAACj/AP/EABQBAQAAAAAAAAAAAAAAAAAAAAj/2gAIAQMQAAAAJ/8A/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAgEBPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAwEBPwB//9k="
}Return languages of the given broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (IdentityLanguage) [ items <application/json > ] Languages List |
{- "_links": [
], - "languages": [
- {
- "uid": "XZax9jV5QH",
- "isoCode": "de-CH",
- "name": "Schweiz",
- "default": true
}
]
}Create a new identity language
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| name required | string [ 1 .. 50 ] characters Name of the new language |
| isoCode required | string [ 1 .. 5 ] characters ISO Code of the new language |
| default required | boolean determinate if the new language should be the default language |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| uid | string (IdentityLanguageUid) uid of the identity language |
| name | string name |
| isoCode | string iso code |
| default | boolean default language indicator |
{- "name": "Schweiz",
- "isoCode": "de-CH",
- "default": true
}{- "_links": [
], - "uid": "XZax9jV5QH",
- "name": "Schweiz",
- "isoCode": "de-CH",
- "default": true
}Set the order of identity languages
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| order required | Array of strings ordered array of all language uid strings |
{- "order": [
- "XZax9jV5QH"
]
}Return the Identity language
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| languageUid required | string (IdentityLanguageUid) Example: XZax9jV5QH uid of the identity language |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| uid | string (IdentityLanguageUid) uid of the identity language |
| name | string name |
| isoCode | string iso code |
| default | boolean default language indicator |
{- "_links": [
], - "uid": "XZax9jV5QH",
- "name": "Schweiz",
- "isoCode": "de-CH",
- "default": true
}Updates an existing identity language
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| languageUid required | string (IdentityLanguageUid) Example: XZax9jV5QH uid of the identity language |
| name | string [ 1 .. 50 ] characters Name of the new language |
| isoCode | string [ 1 .. 5 ] characters ISO Code of the new language |
| default | boolean determinate if the new language should be the default language |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| uid | string (IdentityLanguageUid) uid of the identity language |
| name | string name |
| isoCode | string iso code |
| default | boolean default language indicator |
{- "name": "Schweiz",
- "isoCode": "de-CH",
- "default": true
}{- "_links": [
], - "uid": "XZax9jV5QH",
- "name": "Schweiz",
- "isoCode": "de-CH",
- "default": true
}Delete an existing identity language
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| languageUid required | string (IdentityLanguageUid) Example: XZax9jV5QH uid of the identity language |
Return the list of all recipients of the given Broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Recipient) [ items <application/json > ] Recipient list | |
object <application/json> (Paging) |
{- "_links": [
], - "recipients": [
- {
- "id": "ECHOECHO",
- "firstName": "E",
- "lastName": "Cho",
- "language": "en",
- "state": "active"
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}Remove a list of recipients of the given Broadcast identity from all lists and groups. Note that the actual removal of recipients will happen asynchronously.
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| recipients required | Array of strings (ThreemaId) [ items = 8 characters ] List of Threema IDs to remove from the feed |
{- "recipients": [
- "B4UXXX11"
]
}Return details of a recipient
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| threemaId required | string (ThreemaId) = 8 characters Example: B4UXXX11 Threema ID of the recipient |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (ThreemaId) = 8 characters Threema ID of the recipient |
| firstName | string First name |
| lastName | string Last name |
| language | string Language code of the recipients language setting |
| state | string Enum: "active" "inactive" "invalid" State |
{- "_links": [
- {
- "ref": "detail",
}
], - "id": "B4UXXX11",
- "firstName": "E",
- "lastName": "Cho",
- "language": "en",
- "state": "active"
}Update a recipient’s details
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| threemaId required | string (ThreemaId) = 8 characters Example: B4UXXX11 Threema ID of the recipient |
| firstName required | string [ 1 .. 256 ] characters First name of the recipient |
| lastName required | string [ 1 .. 256 ] characters Last name of the recipient |
| language required | string [ 2 .. 3 ] characters Language of the recipient |
{- "firstName": "Peter",
- "lastName": "Black",
- "language": "en"
}Replace an existing recipient in all ditributionLists, feeds and groups with a new one.
Does not replace the recipient in work-synced lists (eg: 'All').
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| threemaId required | string (ThreemaId) = 8 characters Example: B4UXXX11 Existing Threema ID of the recipient |
| newThreemaId required | string = 8 characters New Threema ID of the recipient |
| distributionLists | Array of strings List of changed distributionList UIDs. |
| feeds | Array of strings List of changed feed UIDs. |
| groups | Array of strings List of changed group UIDs. |
{- "newThreemaId": "B4UXXX11"
}{- "distributionLists": [
- "G53cS1E817"
], - "feeds": [
- "EfZ6LIBl1i"
], - "groups": [
- "anQGXlI62c"
]
}Return base64 encoded jpeg / png image or null
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| avatar | string or null base64 encoded jpeg / png group image |
{- "_links": [
], - "avatar": "/9j/4AAQSkZJRgABAQAAAQABAAD//gAfQ29tcHJlc3NlZCBieSBqcGVnLXJlY29tcHJlc3P/2wCEAAQEBAQEBAQEBAQGBgUGBggHBwcHCAwJCQkJCQwTDA4MDA4MExEUEA8QFBEeFxUVFx4iHRsdIiolJSo0MjRERFwBBAQEBAQEBAQEBAYGBQYGCAcHBwcIDAkJCQkJDBMMDgwMDgwTERQQDxAUER4XFRUXHiIdGx0iKiUlKjQyNEREXP/CABEIAAEAAQMBIgACEQEDEQH/xAAUAAEAAAAAAAAAAAAAAAAAAAAH/9oACAEBAAAAAEL/xAAUAQEAAAAAAAAAAAAAAAAAAAAI/9oACAECEAAAACj/AP/EABQBAQAAAAAAAAAAAAAAAAAAAAj/2gAIAQMQAAAAJ/8A/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAgEBPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAwEBPwB//9k="
}Update Identity Avatar image
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| avatar required | string base 64 encoded jpeg /png image |
{- "avatar": "/9j/4AAQSkZJRgABAQAAAQABAAD//gAfQ29tcHJlc3NlZCBieSBqcGVnLXJlY29tcHJlc3P/2wCEAAQEBAQEBAQEBAQGBgUGBggHBwcHCAwJCQkJCQwTDA4MDA4MExEUEA8QFBEeFxUVFx4iHRsdIiolJSo0MjRERFwBBAQEBAQEBAQEBAYGBQYGCAcHBwcIDAkJCQkJDBMMDgwMDgwTERQQDxAUER4XFRUXHiIdGx0iKiUlKjQyNEREXP/CABEIAAEAAQMBIgACEQEDEQH/xAAUAAEAAAAAAAAAAAAAAAAAAAAH/9oACAEBAAAAAEL/xAAUAQEAAAAAAAAAAAAAAAAAAAAI/9oACAECEAAAACj/AP/EABQBAQAAAAAAAAAAAAAAAAAAAAj/2gAIAQMQAAAAJ/8A/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAgEBPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAwEBPwB//9k="
}Return the list of all bots of the given Broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| q | string (FilterQuery) Example: q=fil Query string to filter the result |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Bot) [ items <application/json > ] Bot list |
{- "_links": [
], - "bots": [
- {
- "_links": [
- {
- "ref": "detail",
}
], - "id": "xxxxxxxxxx",
- "name": "The bot 1",
- "state": "active"
}, - {
- "_links": [
- {
- "ref": "detail",
}
], - "id": "yyyyyyyyy",
- "name": "The bot 2",
- "state": "deleted"
}
]
}Create a bot
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| name required | string [ 1 .. 256 ] characters Bot name |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BotUid) = 10 characters Uid of the bot |
| name | string |
| state | string Enum: "active" "deleted" |
{- "name": "The new bot name"
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "commands",
},
], - "id": "3334osykj4",
- "name": "Bot 2.0",
- "state": "active"
}Return details of a bot
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| botUid required | string (BotUid) = 10 characters Example: 3334osykj4 Uid of the bot |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BotUid) = 10 characters Uid of the bot |
| name | string |
| state | string Enum: "active" "deleted" |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "commands",
},
], - "id": "3334osykj4",
- "name": "Bot 2.0",
- "state": "active"
}Update a bot
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| botUid required | string (BotUid) = 10 characters Example: 3334osykj4 Uid of the bot |
| name required | string [ 1 .. 256 ] characters Bot name |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BotUid) = 10 characters Uid of the bot |
| name | string |
| state | string Enum: "active" "deleted" |
{- "name": "Bot 2.0"
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "commands",
},
], - "id": "3334osykj4",
- "name": "Bot 2.0",
- "state": "active"
}Delete the bot command
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| botUid required | string (BotUid) = 10 characters Example: 3334osykj4 Uid of the bot |
| commandUid required | string (BotCommandUid) = 10 characters Example: gSkZoI3SK6 Uid of the bot command |
Return the list of all bot commands of the given Broadcast identity bot
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| botUid required | string (BotUid) = 10 characters Example: 3334osykj4 Uid of the bot |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (BotCommand) [ items <application/json > ] Bot command list |
{- "_links": [
], - "commands": [
- {
- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "index",
}
], - "id": "zzzzzzzzzz",
- "name": "The bot command 1",
- "state": "active",
- "inputs": [
- "help",
- "join"
], - "output": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}, - {
- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "index",
}
], - "id": "yyyyyyyyyy",
- "name": "The bot command 2",
- "state": "temporary",
- "inputs": [ ],
- "output": [ ]
}
]
}Create a bot command
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| botUid required | string (BotUid) = 10 characters Example: 3334osykj4 Uid of the bot |
| name required | string [ 1 .. 256 ] characters Bot command name |
| inputs | Array of strings Inputs that trigger this bot command (straight quotation marks are not allowed). |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BotCommandUid) = 10 characters Uid of the bot command |
| name | string |
| state | string Enum: "temporary" "active" "inactive" "deleted" |
| inputs | Array of strings Inputs that trigger this bot command (straight quotation marks are not allowed). |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "name": "The new bot command name",
- "inputs": [
- "help"
], - "output": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "index",
}
], - "id": "gSkZoI3SK6",
- "name": "Bot command 2.0",
- "state": "active",
- "inputs": [
- "help"
], - "output": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Return details of a bot command
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| botUid required | string (BotUid) = 10 characters Example: 3334osykj4 Uid of the bot |
| commandUid required | string (BotCommandUid) = 10 characters Example: gSkZoI3SK6 Uid of the bot command |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BotCommandUid) = 10 characters Uid of the bot command |
| name | string |
| state | string Enum: "temporary" "active" "inactive" "deleted" |
| inputs | Array of strings Inputs that trigger this bot command (straight quotation marks are not allowed). |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "index",
}
], - "id": "gSkZoI3SK6",
- "name": "Bot command 2.0",
- "state": "active",
- "inputs": [
- "help"
], - "output": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Update a bot command
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| botUid required | string (BotUid) = 10 characters Example: 3334osykj4 Uid of the bot |
| commandUid required | string (BotCommandUid) = 10 characters Example: gSkZoI3SK6 Uid of the bot command |
| name required | string [ 1 .. 256 ] characters Bot command name |
| inputs | Array of strings Inputs that trigger this bot command (straight quotation marks are not allowed). |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BotUid) = 10 characters Uid of the bot |
| name | string |
| state | string Enum: "active" "deleted" |
{- "name": "Bot Command 2.0",
- "inputs": [
- "help"
], - "output": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "commands",
},
], - "id": "3334osykj4",
- "name": "Bot 2.0",
- "state": "active"
}Update the state of a bot
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| botUid required | string (BotUid) = 10 characters Example: 3334osykj4 Uid of the bot |
| botState required | string (BotState) Enum: "active" "deleted" Example: active state of the bot |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (BotUid) = 10 characters Uid of the bot |
| name | string |
| state | string Enum: "active" "deleted" |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "commands",
},
], - "id": "3334osykj4",
- "name": "Bot 2.0",
- "state": "active"
}Return the list of the distribution lists of the given Broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| q | string (FilterQuery) Example: q=fil Query string to filter the result |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (DistributionList) [ items <application/json > ] Distribution List |
{- "_links": [
], - "distributionLists": [
- {
- "_links": [
- {
- "ref": "detail",
}
], - "id": "yyyyyyyyyy",
- "name": "The Distri 1"
}
]
}Create a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| name required | string [ 1 .. 256 ] characters New distribution list name |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (DistributionListUid) = 10 characters Uid of the distribution list |
| name | string |
| state | string (DistributionListState) Enum: "active" "deleted" state of the distribution list. |
{- "name": "The Distri"
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "recipients",
}, - {
- "ref": "chat",
}, - {
- "ref": "index",
}
], - "id": "nncbasmdl2",
- "name": "The Distri",
- "state": "active"
}Return details of a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (DistributionListUid) = 10 characters Uid of the distribution list |
| name | string |
| state | string (DistributionListState) Enum: "active" "deleted" state of the distribution list. |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "recipients",
}, - {
- "ref": "chat",
}, - {
- "ref": "index",
}
], - "id": "nncbasmdl2",
- "name": "The Distri",
- "state": "active"
}Update the details of a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| name required | string [ 1 .. 256 ] characters New distribution list name |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (DistributionListUid) = 10 characters Uid of the distribution list |
| name | string |
| state | string (DistributionListState) Enum: "active" "deleted" state of the distribution list. |
{- "name": "The Distri 2.0"
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "recipients",
}, - {
- "ref": "chat",
}, - {
- "ref": "index",
}
], - "id": "nncbasmdl2",
- "name": "The Distri",
- "state": "active"
}Delete the distribution list (state dependency = 'deleted')
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
Return all messages of a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (DistributionListChatMessage) [ items <application/json > ] Distribution list chat message list | |
object <application/json> (Paging) |
{- "_links": [
- {
- "ref": "distributionList",
}
], - "messages": [
- {
- "uid": "PV9M5iWXat",
- "subject": "null",
- "author": "info@threema.ch",
- "trackDelivery": "false",
- "createdAt": "2018-02-28T22:20:04+0100",
- "startAt": "2018-02-28T22:20:04+0100",
- "doneAt": "2018-02-28T22:20:04+0100",
- "stats": {
- "failed": "0",
- "successfully": "42",
- "received": "42",
- "read": "42",
- "ack": "42",
- "dec": "42",
- "total": "42"
}
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}Send a message to a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| type | string Message type |
| subject | string or null (ChatMessageSubject) Default: null Custom subject of the message |
| trackDelivery | boolean Default: false (only if feature is granted:) Determinate if message delivery should be tracked |
| startAt | integer Default: null (only if feature is granted:) Specify sending time (UTC Timestamp) |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
| uid | string (DistributionListChatMessageUid) Uid of the distribution list message |
| subject | string or null (ChatMessageSubject) Default: null Custom subject of the message |
| author | string (ChatMessageAuthor) Author of the message |
| trackDelivery | boolean (DistributionListChatMessageTrackDelivery) Indicates if delivery will be tracked |
| createdAt | string <date-time> |
| startAt | string <date-time> |
| doneAt | string <date-time> |
object (MessageStatus) Status | |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| type | string Message type |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "type": "text",
- "subject": "null",
- "trackDelivery": false,
- "startAt": null,
- "body": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}{- "uid": "PV9M5iWXat",
- "subject": "null",
- "author": "info@threema.ch",
- "trackDelivery": "false",
- "createdAt": "2018-02-28T22:20:04+0100",
- "startAt": "2018-02-28T22:20:04+0100",
- "doneAt": "2018-02-28T22:20:04+0100",
- "stats": {
- "failed": "0",
- "successfully": "42",
- "received": "42",
- "read": "42",
- "ack": "42",
- "dec": "42",
- "total": "42"
}, - "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "distributionList",
}, - {
- "ref": "chat",
}
], - "type": "text",
- "body": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Return a message of a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| distributionListChatMessageUid required | string (DistributionListChatMessageUid) Example: PV9M5iWXat Uid of the distribution list message |
| uid | string (DistributionListChatMessageUid) Uid of the distribution list message |
| subject | string or null (ChatMessageSubject) Default: null Custom subject of the message |
| author | string (ChatMessageAuthor) Author of the message |
| trackDelivery | boolean (DistributionListChatMessageTrackDelivery) Indicates if delivery will be tracked |
| createdAt | string <date-time> |
| startAt | string <date-time> |
| doneAt | string <date-time> |
object (MessageStatus) Status | |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| type | string Message type |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "uid": "PV9M5iWXat",
- "subject": "null",
- "author": "info@threema.ch",
- "trackDelivery": "false",
- "createdAt": "2018-02-28T22:20:04+0100",
- "startAt": "2018-02-28T22:20:04+0100",
- "doneAt": "2018-02-28T22:20:04+0100",
- "stats": {
- "failed": "0",
- "successfully": "42",
- "received": "42",
- "read": "42",
- "ack": "42",
- "dec": "42",
- "total": "42"
}, - "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "distributionList",
}, - {
- "ref": "chat",
}
], - "type": "text",
- "body": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Remove a message from a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| distributionListChatMessageUid required | string (DistributionListChatMessageUid) Example: PV9M5iWXat Uid of the distribution list message |
Return message delivery stats of a distribution list message
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| distributionListChatMessageUid required | string (DistributionListChatMessageUid) Example: PV9M5iWXat Uid of the distribution list message |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
| q | string [ 1 .. 256 ] characters filter query |
| state | Array of strings (DeliveryState) filter state |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Delivery) [ items <application/json > ] Delivery list | |
object <application/json> (Paging) |
{- "q": "ECHOECHO Receiver Name",
- "state": [
- "sent",
- "received",
- "read",
- "ack",
- "dec"
]
}{- "_links": [
], - "deliveries": [
- {
- "date": "2018-02-28T22:20:04+0100",
- "id": "ECHOECHO",
- "firstName": "E",
- "lastName": "Cho",
- "language": "en",
- "state": "ack"
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}Return a base64 file content of a distribution list. Only outgoing files can be viewed in Broadcast; incoming files will not be saved and can therefore not be viewed.
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| distributionListChatMessageUid required | string (DistributionListChatMessageUid) Example: PV9M5iWXat Uid of the distribution list message |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| file | string base64 encoded file |
| filename | string Name of the file |
| mimetype | string MimeType of the file |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "chat",
}, - {
- "ref": "distributionList",
}
], - "file": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg==",
- "filename": "filename.dat",
- "mimetype": "application/octet-stream"
}Return the list of the recipients of a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Recipient) [ items <application/json > ] Recipient list | |
object <application/json> (Paging) |
{- "_links": [
- {
- "ref": "feed",
}
], - "recipients": [
- {
- "id": "B44UXX11",
- "firstName": "E",
- "lastName": "Cho",
- "language": "en",
- "state": "active"
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}Add recipients to a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| recipients required | Array of strings (ThreemaId) [ items = 8 characters ] List of Threema IDs |
| replaceExisting | boolean Default: false Replace existing recipients with new list of recipients |
| filterInvalid | boolean Default: false Filter invalid and revoked Threema IDs |
{- "recipients": [
- "B4UXXX11"
], - "replaceExisting": false,
- "filterInvalid": false
}[- "0-12",
- "ECHOECHOECHO",
- "REVOKED"
]Remove recipients to a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| recipients required | Array of strings (ThreemaId) [ items = 8 characters ] List of Threema IDs to remove from Distribution List |
{- "recipients": [
- "B4UXXX11"
]
}Remove invalid Identities of a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
Threema ID of the recipient
[- "B4UXXX11",
- "ECHOECHO"
]Update the state of a distribution list
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| distributionListUid required | string (DistributionListUid) = 10 characters Example: nncbasmdl2 Uid of the distribution list |
| distributionListState required | string (DistributionListState) Enum: "active" "deleted" Example: active state of the distribution list. |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (DistributionListUid) = 10 characters Uid of the distribution list |
| name | string |
| state | string (DistributionListState) Enum: "active" "deleted" state of the distribution list. |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "recipients",
}, - {
- "ref": "chat",
}, - {
- "ref": "index",
}
], - "id": "nncbasmdl2",
- "name": "The Distri",
- "state": "active"
}Return the list of all feeds of the given Broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| q | string (FilterQuery) Example: q=fil Query string to filter the result |
| state | string (StateFilter) Enum: "active" "deleted" Example: state=active State to filter the result |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (FeedSimple) [ items <application/json > ] Feed list |
{- "_links": [
], - "feeds": [
- {
- "_links": [
- {
- "ref": "detail",
}
], - "id": "xxxxxxxxxx",
- "name": "The feed 1",
- "state": "active"
}, - {
- "_links": [
- {
- "ref": "detail",
}
], - "id": "yyyyyyyyy",
- "name": "The feed 2",
- "state": "active"
}
]
}Create a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| name required | string [ 1 .. 256 ] characters Feed name |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
| commands_on | Array of strings Commands to subscribe to the feed (straight quotation marks are not allowed). |
| commands_off | Array of strings Commands to unsubscribe to the feed (straight quotation marks are not allowed). |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (FeedUid) = 10 characters Uid of the feed |
| name | string |
| state | string Enum: "active" "deleted" |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
| commands_on | Array of strings Commands to subscribe to the feed. |
| commands_off | Array of strings Commands to unsubscribe to the feed. |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "name": "The new feed name",
- "description": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "commands_on": [
- "start {channel}"
], - "commands_off": [
- "stop {channel}"
], - "message_on": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "message_off": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "recipients",
}, - {
- "ref": "chat",
},
], - "id": "3334osykj4",
- "name": "The feed",
- "state": "active",
- "description": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "commands_on": [
- "start {channel}"
], - "commands_off": [
- "stop {channel}"
], - "message_on": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "message_off": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Return details of a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (FeedUid) = 10 characters Uid of the feed |
| name | string |
| state | string Enum: "active" "deleted" |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
| commands_on | Array of strings Commands to subscribe to the feed. |
| commands_off | Array of strings Commands to unsubscribe to the feed. |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "recipients",
}, - {
- "ref": "chat",
},
], - "id": "3334osykj4",
- "name": "The feed",
- "state": "active",
- "description": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "commands_on": [
- "start {channel}"
], - "commands_off": [
- "stop {channel}"
], - "message_on": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "message_off": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Update a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| name required | string [ 1 .. 256 ] characters Feed name |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
| commands_on | Array of strings Commands to subscribe to the feed (straight quotation marks are not allowed). |
| commands_off | Array of strings Commands to unsubscribe to the feed (straight quotation marks are not allowed). |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (FeedUid) = 10 characters Uid of the feed |
| name | string |
| state | string Enum: "active" "deleted" |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
| commands_on | Array of strings Commands to subscribe to the feed. |
| commands_off | Array of strings Commands to unsubscribe to the feed. |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "name": "Feed 2.0",
- "description": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "commands_on": [
- "start {channel}"
], - "commands_off": [
- "stop {channel}"
], - "message_on": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "message_off": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "recipients",
}, - {
- "ref": "chat",
},
], - "id": "3334osykj4",
- "name": "The feed",
- "state": "active",
- "description": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "commands_on": [
- "start {channel}"
], - "commands_off": [
- "stop {channel}"
], - "message_on": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "message_off": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Return all messages of a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (FeedChatMessage) [ items <application/json > ] Feed chat message list | |
object <application/json> (Paging) |
{- "_links": [
- {
- "ref": "feed",
}
], - "messages": [
- {
- "uid": "PV9M5iWXat",
- "subject": "null",
- "author": "info@threema.ch",
- "trackDelivery": "false",
- "createdAt": "2018-02-28T22:20:04+0100",
- "startAt": "2018-02-28T22:20:04+0100",
- "doneAt": "2018-02-28T22:20:04+0100",
- "stats": {
- "failed": "0",
- "successfully": "42",
- "received": "42",
- "read": "42",
- "ack": "42",
- "dec": "42",
- "total": "42"
}
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}Send a message to a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| type | string Message type |
| subject | string or null (ChatMessageSubject) Default: null Custom subject of the message |
| trackDelivery | boolean Default: false (only if feature is granted:) Determinate if message delivery should be tracked |
| startAt | integer Default: null (only if feature is granted:) Specify sending time (UTC Timestamp) |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
| uid | string (FeedChatMessageUid) = 10 characters Uid of the feed message |
| subject | string or null (ChatMessageSubject) Default: null Custom subject of the message |
| author | string (ChatMessageAuthor) Author of the message |
| trackDelivery | boolean (FeedChatMessageTrackDelivery) Indicates if delivery will be tracked |
| createdAt | string <date-time> |
| startAt | string <date-time> |
| doneAt | string <date-time> |
object (MessageStatus) Status | |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| type | string Message type |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "type": "text",
- "subject": "null",
- "trackDelivery": false,
- "startAt": null,
- "body": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}{- "uid": "PV9M5iWXat",
- "subject": "null",
- "author": "info@threema.ch",
- "trackDelivery": "false",
- "createdAt": "2018-02-28T22:20:04+0100",
- "startAt": "2018-02-28T22:20:04+0100",
- "doneAt": "2018-02-28T22:20:04+0100",
- "stats": {
- "failed": "0",
- "successfully": "42",
- "received": "42",
- "read": "42",
- "ack": "42",
- "dec": "42",
- "total": "42"
}, - "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "feed",
}, - {
- "ref": "chat",
}
], - "type": "text",
- "body": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Return a message of a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| feedChatMessageUid required | string (FeedChatMessageUid) = 10 characters Example: PV9M5iWXat Uid of the feed message |
| uid | string (FeedChatMessageUid) = 10 characters Uid of the feed message |
| subject | string or null (ChatMessageSubject) Default: null Custom subject of the message |
| author | string (ChatMessageAuthor) Author of the message |
| trackDelivery | boolean (FeedChatMessageTrackDelivery) Indicates if delivery will be tracked |
| createdAt | string <date-time> |
| startAt | string <date-time> |
| doneAt | string <date-time> |
object (MessageStatus) Status | |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| type | string Message type |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "uid": "PV9M5iWXat",
- "subject": "null",
- "author": "info@threema.ch",
- "trackDelivery": "false",
- "createdAt": "2018-02-28T22:20:04+0100",
- "startAt": "2018-02-28T22:20:04+0100",
- "doneAt": "2018-02-28T22:20:04+0100",
- "stats": {
- "failed": "0",
- "successfully": "42",
- "received": "42",
- "read": "42",
- "ack": "42",
- "dec": "42",
- "total": "42"
}, - "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "feed",
}, - {
- "ref": "chat",
}
], - "type": "text",
- "body": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Remove a message from a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| feedChatMessageUid required | string (FeedChatMessageUid) = 10 characters Example: PV9M5iWXat Uid of the feed message |
Return message delivery stats of a feed message
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| feedChatMessageUid required | string (FeedChatMessageUid) = 10 characters Example: PV9M5iWXat Uid of the feed message |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
| q | string [ 1 .. 256 ] characters filter query |
| state | Array of strings (DeliveryState) filter state |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Delivery) [ items <application/json > ] Delivery list | |
object <application/json> (Paging) |
{- "q": "ECHOECHO Receiver Name",
- "state": [
- "sent",
- "received",
- "read",
- "ack",
- "dec"
]
}{- "_links": [
], - "deliveries": [
- {
- "date": "2018-02-28T22:20:04+0100",
- "id": "ECHOECHO",
- "firstName": "E",
- "lastName": "Cho",
- "language": "en",
- "state": "ack"
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}Return a base64 file content of a feed. Only outgoing files can be viewed in Broadcast; incoming files will not be saved and can therefore not be viewed.
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| feedChatMessageUid required | string (FeedChatMessageUid) = 10 characters Example: PV9M5iWXat Uid of the feed message |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| file | string base64 encoded file |
| filename | string Name of the file |
| mimetype | string MimeType of the file |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "chat",
}, - {
- "ref": "feed",
}
], - "file": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg==",
- "filename": "filename.dat",
- "mimetype": "application/octet-stream"
}Return the list of all subscribers of a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Recipient) [ items <application/json > ] Recipient list | |
object <application/json> (Paging) |
{- "_links": [
- {
- "ref": "feed",
}
], - "recipients": [
- {
- "id": "ECHOECHO",
- "firstName": "E",
- "lastName": "Cho",
- "language": "en",
- "state": "active"
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}Add subscribers to a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| recipients required | Array of strings (ThreemaId) [ items = 8 characters ] List of Threema IDs |
| replaceExisting | boolean Default: false Replace existing subscribers with new list of subscribers |
| filterInvalid | boolean Default: false Filter invalid and revoked Threema IDs |
{- "recipients": [
- "B4UXXX11"
], - "replaceExisting": false,
- "filterInvalid": false
}[- "0-12",
- "ECHOECHOECHO",
- "REVOKED"
]Remove subscribers to a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| recipients required | Array of strings (ThreemaId) [ items = 8 characters ] List of Threema IDs to remove from the feed |
{- "recipients": [
- "B4UXXX11"
]
}Update the state of a feed
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| feedUid required | string (FeedUid) = 10 characters Example: 3334osykj4 Uid of the feed |
| feedState required | string (FeedState) Enum: "active" "deleted" Example: active state of the feed. |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (FeedUid) = 10 characters Uid of the feed |
| name | string |
| state | string Enum: "active" "deleted" |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
| commands_on | Array of strings Commands to subscribe to the feed. |
| commands_off | Array of strings Commands to unsubscribe to the feed. |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) | |
object (ChatMessageTranslation) All translated messages (Max. 3500 bytes per message) |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "recipients",
}, - {
- "ref": "chat",
},
], - "id": "3334osykj4",
- "name": "The feed",
- "state": "active",
- "description": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "commands_on": [
- "start {channel}"
], - "commands_off": [
- "stop {channel}"
], - "message_on": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}, - "message_off": {
- "de": "Nachricht",
- "en": "Message",
- "tlh": "Qln"
}
}Return the list of all groups of the given Broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| states | Array of strings or null (GroupState) Enum: "active" "deleted" states of the group |
| saveChatHistory | boolean or null only show groups which saves or does not save chat history |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Group) [ items <application/json > ] Group list |
{- "states": [
- "active",
- "deleted"
], - "saveChatHistory": true
}{- "_links": [
], - "groups": [
- {
- "_links": [
], - "id": "aaaaaa",
- "name": "Group 1",
- "state": "active",
- "saveChatHistory": false
}, - {
- "_links": [
], - "id": "bbbbbb",
- "name": "Group 2",
- "state": "deleted",
- "saveChatHistory": true
}
]
}Create a group
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| name required | string [ 0 .. 256 ] characters Name of the new group |
| members required | Array of strings List of Threema IDs |
| saveChatHistory | boolean Once this setting is activated, the entire group conversation (including incoming messages) is saved. All group members will be notified about changes to this setting. |
| filterInvalid | boolean Default: false Filter double, invalid and revoked Threema IDs |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (GroupUid) = 10 characters Uid of the group |
| name | any |
| state | any Enum: "active" "deleted" |
| saveChatHistory | boolean |
{- "name": "Project Baxter",
- "members": [
- "ECHOECHO"
], - "saveChatHistory": true,
- "filterInvalid": false
}{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "member",
}, - {
- "ref": "chat",
}, - {
- "ref": "image",
},
], - "id": "oopphh22uu",
- "name": "Project Farfalla",
- "state": "active",
- "saveChatHistory": false
}Return details of a group
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| id | string (GroupUid) = 10 characters Uid of the group |
| name | any |
| state | any Enum: "active" "deleted" |
| saveChatHistory | boolean |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "member",
}, - {
- "ref": "chat",
}, - {
- "ref": "image",
},
], - "id": "oopphh22uu",
- "name": "Project Farfalla",
- "state": "active",
- "saveChatHistory": false
}Update the details of a group
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
| name required | string [ 0 .. 256 ] characters The new name for the group |
| saveChatHistory | boolean Once this setting is activated, the entire group conversation (including incoming messages) is saved. All group members will be notified about changes to this setting. |
{- "name": "Project Bauxi",
- "saveChatHistory": true
}Remove a group, and send the information to all members
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
Return all messages of a group chat
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (GroupChatMessage) [ items <application/json > ] Message list of group chat (descending by createdAt) | |
object <application/json> (Paging) |
{- "_links": [
- {
- "ref": "group",
}
], - "messages": [
- {
- "id": "GbeRraMd7S",
- "messageId": "7b324aca6b4509ea",
- "from": "SENDERXY",
- "type": "string",
- "body": "How are you?",
- "caption": "Does this look good?",
- "createdAt": "2018-02-28T22:20:04+0100"
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}Send a message to a group
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
| type | string Message type |
| body | string <= 3500 characters Content of the message (Max 3500 bytes) |
| id | string (GroupChatMessageUid) = 10 characters Uid of the group message |
| messageId | string (ApiMessageId) HEX representation of the identifier of the message |
| from | string Threema ID of the sender |
| type | string Message type |
| body | string Content (only available for text messages) (utf8mb4 encoded) |
| caption | string Content (only available for file messages) (utf8mb4 encoded) |
| createdAt | string <date-time> |
Array of objects <application/json> (Link) [ items <application/json > ] |
{- "type": "text",
- "body": "Hello, this is a test message!"
}{- "id": "GbeRraMd7S",
- "messageId": "7b324aca6b4509ea",
- "from": "SENDERXY",
- "type": "text",
- "body": "message body",
- "caption": "Does this look good?",
- "createdAt": "2018-02-28T22:20:04+0100",
- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "chat",
}, - {
- "ref": "group",
}
]
}Return a message of a group chat
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
| groupChatMessageUid required | string (GroupChatMessageUid) = 10 characters Example: GbeRraMd7S Uid of the group message |
| id | string (GroupChatMessageUid) = 10 characters Uid of the group message |
| messageId | string (ApiMessageId) HEX representation of the identifier of the message |
| from | string Threema ID of the sender |
| type | string Message type |
| body | string Content (only available for text messages) (utf8mb4 encoded) |
| caption | string Content (only available for file messages) (utf8mb4 encoded) |
| createdAt | string <date-time> |
Array of objects <application/json> (Link) [ items <application/json > ] |
{- "id": "GbeRraMd7S",
- "messageId": "7b324aca6b4509ea",
- "from": "SENDERXY",
- "type": "text",
- "body": "message body",
- "caption": "Does this look good?",
- "createdAt": "2018-02-28T22:20:04+0100",
- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "chat",
}, - {
- "ref": "group",
}
]
}Remove a message from a group chat
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
| groupChatMessageUid required | string (GroupChatMessageUid) = 10 characters Example: GbeRraMd7S Uid of the group message |
Return a base64 file content of a group chat message. Only outgoing files can be viewed in Broadcast; incoming files will not be saved and can therefore not be viewed.
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
| groupChatMessageUid required | string (GroupChatMessageUid) = 10 characters Example: GbeRraMd7S Uid of the group message |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| file | string base64 encoded file |
| filename | string Name of the file |
| mimetype | string MimeType of the file |
{- "_links": [
- {
- "ref": "detail",
}, - {
- "ref": "chat",
}, - {
- "ref": "group",
}
], - "file": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg==",
- "filename": "filename.dat",
- "mimetype": "application/octet-stream"
}Return base64 encoded jpeg / png image or null
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| image | string or null base64 encoded jpeg / png group image |
{- "_links": [
- {
- "ref": "group",
}
], - "image": "/9j/4AAQSkZJRgABAQAAAQABAAD//gAfQ29tcHJlc3NlZCBieSBqcGVnLXJlY29tcHJlc3P/2wCEAAQEBAQEBAQEBAQGBgUGBggHBwcHCAwJCQkJCQwTDA4MDA4MExEUEA8QFBEeFxUVFx4iHRsdIiolJSo0MjRERFwBBAQEBAQEBAQEBAYGBQYGCAcHBwcIDAkJCQkJDBMMDgwMDgwTERQQDxAUER4XFRUXHiIdGx0iKiUlKjQyNEREXP/CABEIAAEAAQMBIgACEQEDEQH/xAAUAAEAAAAAAAAAAAAAAAAAAAAH/9oACAEBAAAAAEL/xAAUAQEAAAAAAAAAAAAAAAAAAAAI/9oACAECEAAAACj/AP/EABQBAQAAAAAAAAAAAAAAAAAAAAj/2gAIAQMQAAAAJ/8A/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAgEBPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAwEBPwB//9k="
}Update the image of the group
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
| image required | string a base 64 encoded square jpeg or png image - max 512px. non fitting dimensions will be cropped |
{- "image": "/9j/4AAQSkZJRgABAQAAAQABAAD//gAfQ29tcHJlc3NlZCBieSBqcGVnLXJlY29tcHJlc3P/2wCEAAQEBAQEBAQEBAQGBgUGBggHBwcHCAwJCQkJCQwTDA4MDA4MExEUEA8QFBEeFxUVFx4iHRsdIiolJSo0MjRERFwBBAQEBAQEBAQEBAYGBQYGCAcHBwcIDAkJCQkJDBMMDgwMDgwTERQQDxAUER4XFRUXHiIdGx0iKiUlKjQyNEREXP/CABEIAAEAAQMBIgACEQEDEQH/xAAUAAEAAAAAAAAAAAAAAAAAAAAH/9oACAEBAAAAAEL/xAAUAQEAAAAAAAAAAAAAAAAAAAAI/9oACAECEAAAACj/AP/EABQBAQAAAAAAAAAAAAAAAAAAAAj/2gAIAQMQAAAAJ/8A/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAgEBPwB//8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAgBAwEBPwB//9k="
}Return the list of all members of a group
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Recipient) [ items <application/json > ] List of group members |
{- "_links": [
- {
- "ref": "group",
}
], - "members": [
- {
- "_links": [
- {
- "ref": "detail",
}
], - "id": "AAAAAAAA",
- "firstName": null,
- "lastName": null,
- "language": null,
- "state": "string"
}, - {
- "_links": [
- {
- "ref": "detail",
}
], - "id": "BBBBBBBB",
- "firstName": null,
- "lastName": null,
- "language": null,
- "state": "string"
}
]
}| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
List of the new Threema IDs
| members required | Array of strings (ThreemaId) [ items = 8 characters ] List of Threema IDs |
| replaceExisting | boolean Default: false Replace existing members with new list of members |
| filterInvalid | boolean Default: false Filter double, invalid and revoked Threema IDs |
{- "members": [
- "B4UXXX11"
], - "replaceExisting": false,
- "filterInvalid": false
}[- "0-12",
- "ECHOECHOECHO",
- "REVOKED"
]Remove members from a group chat
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
List of the Threema IDs
Threema ID of the recipient
[- "B4UXXX11",
- "ECHOECHO"
]Remove invalid identities of a group
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| groupUid required | string (GroupUid) = 10 characters Example: oopphh22uu Uid of the group |
Threema ID of the recipient
[- "B4UXXX11",
- "ECHOECHO"
](only if feature is granted:) Return the list of all polls of the given Broadcast identity
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| states | Array of strings or null (PollState) Enum: "open" "closed" states of the poll |
| choice_modes | Array of strings or null (PollChoiceMode) Enum: "single" "multiple" choice modes of the poll |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (Poll) [ items <application/json > ] Poll list |
{- "states": [
- "open",
- "closed"
], - "choice_modes": [
- "single",
- "multiple"
]
}{- "_links": [
- {
- "ref": "distributionList",
}
], - "polls": [
- {
- "_links": [
- {
- "ref": "detail",
}
], - "uid": "aabb112233",
- "state": "open",
- "choice_mode": "single",
- "detailedResults": true,
- "distinctVotes": 15,
- "titles": {
- "en": "title",
- "de": "titel"
}, - "choices": [
- {
- "uid": "7PcoUKecxm",
- "name": {
- "en": "Choice #1",
- "de": "Antwortmöglichkeit #1"
}
}, - {
- "uid": "8PcoUKecxm",
- "name": {
- "en": "Choice #2",
- "de": "Antwortmöglichkeit #2"
}
}
]
}, - {
- "_links": [
- {
- "ref": "detail",
}
], - "uid": "ccee445566",
- "state": "closed",
- "choice_mode": "multiple",
- "detailedResults": true,
- "distinctVotes": 50,
- "titles": {
- "en": "title",
- "de": "titel"
}, - "choices": [
- {
- "uid": "9PcoUKecxm",
- "name": {
- "en": "Choice #1",
- "de": "Antwortmöglichkeit #1"
}
}, - {
- "uid": "0PcoUKecxm",
- "name": {
- "en": "Choice #2",
- "de": "Antwortmöglichkeit #2"
}
}
]
}
]
}Return details of a poll
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| pollUid required | string (PollUid) = 10 characters Example: edMk465KIA uid of the poll |
Array of objects <application/json> (Link) [ items <application/json > ] | |
| uid | string (PollUid) = 10 characters uid of the poll |
| state | string (PollState) Enum: "open" "closed" Poll State. |
| choiceMode | string (PollChoiceMode) Enum: "single" "multiple" Single or multiple choice mode. |
| detailedResults | boolean (PollDetailedResults) Show detailed vote results of each participant in the cockpit |
| distinctVotes | integer (PollDistinctVotes) Total votes of the poll |
object (PollTitleTranslation) All translated titles | |
Array of objects (PollChoice) |
{- "_links": [
- {
- "ref": "distributionListChatMessage",
}, - {
- "ref": "feedChatMessage",
}, - {
- "ref": "closePoll",
}, - {
- "ref": "choiceVotes",
}
], - "uid": "edMk465KIA",
- "state": "open",
- "choiceMode": "single",
- "detailedResults": true,
- "distinctVotes": 15,
- "title": {
- "de": "Titel",
- "en": "Title",
- "tlh": "Qln"
}, - "choices": [
- {
- "uid": "7PcoUKecxm",
- "votes": 42,
- "name": {
- "de": "Antwortmöglichkeit #1",
- "en": "Choice #1",
- "tlh": "Qln"
}
}
]
}Get a list of poll choice votes
| broadcastUid required | string (BroadcastUid) = 10 characters Example: xxyyzz0099 Uid of the Broadcast identity |
| pollUid required | string (PollUid) = 10 characters Example: edMk465KIA uid of the poll |
| pollChoiceUid required | string (PollChoiceUid) = 10 characters Example: 7PcoUKecxm uid of the poll choice |
| page | integer (Page) Example: page=9 Number of page (starting with: 0) |
| pageSize | integer (PageSize) Example: pageSize=20 Results per page (max. recommended: 1000) |
| q | string [ 1 .. 255 ] characters filter query |
| vote | boolean filter votes |
Array of objects <application/json> (Link) [ items <application/json > ] | |
Array of objects <application/json> (PollChoiceVote) [ items <application/json > ] Vote list | |
object <application/json> (Paging) |
{- "q": "ECHOECHO",
- "vote": true
}{- "_links": [
- {
- "ref": "poll",
}
], - "votes": [
- {
- "id": "ECHOECHO",
- "vote": true
}
], - "_paging": {
- "count": 20,
- "total": 400,
- "page": 9,
- "_links": [
- {
- "ref": "next",
}, - {
- "ref": "previous",
}
]
}
}