API documentation

login

POST Login `/login`

https://rest.messengerpeople.com/api/v14/login

Create an API token for this user, that can be used instead of the API key to identify the users actions.

Parameter	Type	Description
`username`	string	Login username (email address)
`password`	password	Login password
`channel_type`	string	Optional The type of channels accessed by the logged in user. Possible values are `cs` for customer-service channels, and `nl` for newsletter channels. Leave empty for listing all channels.
`code`	string	Optional V2 A code generated for new agents or when restoring a forgotten password. If the code matches, the specified password is used from now on for the agent. Or a code sent for 2-factor authentication.
`token`	string	Optional V2 Token with login data
`channel_id`	string	Optional V12 Channel ID for activating this channel
`two_factor_userid`	string	Optional V13 The whatsapp number to which the 2fa code will be sent, cannot be overwritten

POST Password Code /login/code
https://rest.messengerpeople.com/api/v14/login/code
Generate a code that is sent to the email address of the agent for restoring a forgotten password.

Parameter Value Type Description

username string
Login username (email address)
Request
Response
DELETE Login /login
https://rest.messengerpeople.com/api/v14/login
Logout a user who previously logged in
This method has no parameters.
Request
Response

user

GET Details `/user/{id}`

https://rest.messengerpeople.com/api/v14/user/{id}

Get basic informations about one or multiple users. If the id is omitted users can be listed using various filters.

Parameter	Type	Description
`id`	mixed	Optional The user ID, number or secret hash code. Multiple ids can be separated by comma.
`limit`	integer	Optional Default: `500` This is the amount of results that is returned.
`status`	boolean(0/1)	Optional V2 Active and inactive users are listed per default. Use `1` for listing only active users and `0` for listing only inactive users.
`offset`	integer	Optional Default: `0` This is the amount of results skipped in the result set.
`blocked`	boolean(0/1)	Optional Default: `0` V2 Set to `1` for listing only blocked users
`targeting_id`	integer	Optional Default: `0` V2 List only active users of this targeting group.
`search`	string	Optional V2 Users can be searched by id/phone number (if the search attribute is numeric) or by parts of their name or referral info.
`order`	string	Optional V2 User lists are ordered by creation date per default. `stopped`, `id`, `name`, `messenger`, `blocked` or `last_chat` can be specified to order by those attributes.
`asc`	boolean(0/1)	Optional Default: `0` V2 Normally user lists are sorted descending which means latest first.
`last_chat`	boolean(0/1)	Optional Default: `0` V2 Set if the time of the last user chat should be included. Retrieving the information costs more time.
`customfields`	boolean(0/1)	Optional Default: `0` V6 Set if custom fields should be included.
`filter`	json	Optional V13 A JSON array of user filter. If multiple filters are specified, all are applied. Each filter element can have the following elements: `type`: mandatory type of the filter. Possible value is `created` or `customfield` `after`: UNIX timestamp of created or last update of a customfield `before`: UNIX timestamp of created or last update of a customfield `name`: name of a custom field (default all) `value`: Value of a custom field
`inbotchat`	boolean(0/1)	Optional Only list users who have latest been chatting with the chatbot without having a ticket
`output_format`	string	Optional Default: `json` V14 Possible values json or csv. Only applies for listing users.

PUT Data `/user/{id}`

https://rest.messengerpeople.com/api/v14/user/{id}

Update data of a specific user

Parameter Value Type Description

id

mixed

The user ID, number or secret hash code. Multiple ids can be separated by comma.

fields

json

Requires JSON with field name => field value.
Possible field names:

name: name of the user
agent: email-address of an agent that should be assigned

customfields: Please see possible user properties by using the GET USER PROPERTIES call.
Example:

{  
"name": "John Doe",  
"agent": "john.doe@foo.bar",  
"customfields": {  
"haircolor": "brown",  
"123": "premium"  
},  
"addlabel": [1,2,3],  
"removelabel": [4,5,6]  
}

POST Upload CSV `/user/csv`

https://rest.messengerpeople.com/api/v14/user/csv

Bulk update users by uploading a csv file.

Since V13 also bulk create users is possible

This is not a JSON Request, please use the default HTTP Multi Part Request

Parameter Type Description

Parameter	Type	Description
`file`	file	The CSV file containing the user list. Only fields provided within the file will be handled The following fields are possible: Regular fields: id mandatory Id of the contact, differs by messengers, for WhatsApp for example this would be a phone number messenger mandatory Identifier for the contacts messenger. Possible values: CC for Custom Messenger, FB for Facebook, IM for IMessage, TG for Telegram, VI for Viber, WB for WhatsApp, WN for Notify name Username of the contact Control fields: activated 1: user should be activated for mia, 0: user should be deactivated for mia blocked 1: user should be blocked, 0: user should be unblocked deactivated 1: user should be deactivated for mia, 0: user should be activated for mia deleted: 1: user should be deleted, 0: user should not be deleted Every user property which is set up for your channel, by the name of the property

file

file

The CSV file containing the user list.
Only fields provided within the file will be handled
The following fields are possible:

Regular fields:
- id
  mandatory
  Id of the contact, differs by messengers, for WhatsApp for example this would be a phone number
- messenger
  mandatory
  Identifier for the contacts messenger. Possible values: CC for Custom Messenger, FB for Facebook, IM for IMessage, TG for Telegram, VI for Viber, WB for WhatsApp, WN for Notify
- name
  Username of the contact
Control fields:
- activated
  1: user should be activated for mia, 0: user should be deactivated for mia
- blocked
  1: user should be blocked, 0: user should be unblocked
- deactivated
  1: user should be deactivated for mia, 0: user should be activated for mia
- deleted:
  1: user should be deleted, 0: user should not be deleted
Every user property which is set up for your channel, by the name of the property

DELETE Delete /user/{id}
https://rest.messengerpeople.com/api/v14/user/{id}
Delete the user and his chats. Chats and information about the user are deleted immediately after this call. The user itself is scheduled for deletion and will be deleted completely during the next 2hours afer being removed from broadcast lists etc.

Parameter Value Type Description

id mixed
The user ID, number or secret hash code. Multiple IDs can be separated by comma.
Request
Response
PUT Start /user/{id}/start
https://rest.messengerpeople.com/api/v14/user/{id}/start
Activate a user that was previously deactivated

Parameter Value Type Description

id mixed
The user ID, number or secret hash code. Multiple IDs can be separated by comma.
Request
Response
PUT Stop /user/{id}/stop
https://rest.messengerpeople.com/api/v14/user/{id}/stop
Deactivate a user

Parameter Value Type Description

id mixed
The user ID, number or secret hash code. Multiple IDs can be separated by comma.
Request
Response
PUT Block /user/{id}/block
https://rest.messengerpeople.com/api/v14/user/{id}/block
Block a user

Parameter Value Type Description

id mixed
The user ID, number or secret hash code. Multiple IDs can be separated by comma.
Request
Response
PUT Unblock /user/{id}/unblock
https://rest.messengerpeople.com/api/v14/user/{id}/unblock
Unblock a user that was previously blocked

Parameter Value Type Description

id mixed
The user ID, number or secret hash code. Multiple IDs can be separated by comma.
Request
Response
GET Categories /user/{id}/categories
https://rest.messengerpeople.com/api/v14/user/{id}/categories
Get categories of a user

Parameter Value Type Description

id mixed
The user ID, number or secret hash code. Multiple IDs can be separated by comma.
Request
Response

PUT Categories `/user/{id}/categories`

https://rest.messengerpeople.com/api/v14/user/{id}/categories

Set categories of a user

Parameter	Type	Description
`id`	mixed	The user ID, number or secret hash code. Multiple IDs can be separated by comma.
`category_id`	integer	The category ID.
`status`	boolean(0/1)	Set active (`1`) or inactive (`0`).

POST Note `/user/{id}/note`

warning

warning This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/user/{id}/note

Add a note to the user

Parameter	Value	Type	Description
`id`		mixed	The user ID, number or secret hash code. Multiple IDs can be separated by comma.
`note`		string	V2 The content of the note you want to add to the user

GET Property `/user/property`

https://rest.messengerpeople.com/api/v14/user/property

Get a user property for a list of users

Parameter	Value	Type	Description
`id`		string	Optional A comma-separated list of user numbers. Leave empty to list all users with the property.
`name`		string	The name of the user property

PUT Property `/user/property`

https://rest.messengerpeople.com/api/v14/user/property

Set a user property for a list of users

Parameter	Type	Description
`id`	string	The user number. Multiple numbers can be separated by comma.
`name`	string	The name of the user property
`value`	string	The value of the user property. Must be compliant with the possible field values.

User properties

GET User properties /custom/{id}
https://rest.messengerpeople.com/api/v14/custom/{id}
Get all user properties

Parameter Value Type Description

id mixed
Optional
The field ID or name

hidden boolean(0/1)
V8
Set to 1 if hidden fields should be included.
Request
Response

Parameter	Value	Type	Description
`id`		mixed	Optional The field ID or name
`hidden`		boolean(0/1)	V8 Set to 1 if hidden fields should be included.

POST User Property `/custom`

https://rest.messengerpeople.com/api/v14/custom

Add a new user property

Parameter	Type	Description
`name`	string	The name of the user property, no spaces. `"fieldname"` will result in a bot variable $fieldname$ .
`type`	string	Possible field types: `number` `text` `word` `enum` `collection` `location` `date` `time`
`values`	string	Optional Possible values or conditions for this field. e.g. `>=2 <=9` for field type `number`. `a,b,c,d` for field type `enumeration` or `collection`
`expiration`	integer	Expiration in seconds `0`: won't be saved and can only be used in the answer associated with the input `>0`: Seconds before information will be purged `-1`: permanent
`user_visible`	boolean(0/1)	Field can be edited on the "profile page" by the user.
`label`	string	Internal name for the variable (also shown on users profile page)
`position`	integer	Optional V8 The position of the field. Per default it is added at the end.
`limited_access`	boolean(0/1)	V8 Field is only visible with appropriate rights (not for normal agents).
`default_value`	string	Optional V12 Default value that is replaced if no value is stored in the user profile.

PUT User Property `/custom`

https://rest.messengerpeople.com/api/v14/custom

Edit a user property

Parameter	Type	Description
`id`	mixed	The field ID or name
`name`	string	The name of the user property, no spaces. `"fieldname"` will result in a bot variable $fieldname$ .
`type`	string	Possible field types: `number` `text` `word` `enum` `collection` `location` `date` `time`
`values`	string	Optional Possible values or conditions for this field. e.g. `>=2 <=9` for field type `number`. `a,b,c,d` for field type `enumeration` or `collection`
`expiration`	integer	Expiration in seconds `0`: won't be saved and can only be used in the answer associated with the input `>0`: Seconds before information will be purged `-1`: permanent
`user_visible`	boolean(0/1)	Field can be edited on the "profile page" by the user.
`label`	string	Internal name for the variable (also shown on users profile page)
`position`	integer	Optional V8 The position of the field.
`limited_access`	boolean(0/1)	V8 Field is only visible with appropriate rights (not for normal agents).
`default_value`	string	Optional V12 Default value that is replaced if no value is stored in the user profile.

DELETE User Property /custom
https://rest.messengerpeople.com/api/v14/custom
Delete a user property

Parameter Value Type Description

id mixed
The field ID or name
Request
Response

User-Chat

GET history `/chat`

https://rest.messengerpeople.com/api/v14/chat

Get the last chat messages of a user. With version 6 or higher addional information for outgoing chat is returned. Especially the send_status with the following possible values (availability depending on the messenger): 0 = sending in progress, 1 = sent (in WhatsApp and Viber 1= delivered), 2 = read, -1 = failed, -2 = user rejected, left the channel or 24 hour window is exceeded, 4 = Notification sent, 5 = Notification delivered, 6 = Notification read, -5 Notification failed, -6 Notification user does not exist

Parameter	Type	Description
`id`	mixed	The user ID, number or secret hash code. Multiple ids can be separated by comma.
`limit`	integer	Optional Default: `50` This is the amount of results that is returned.
`showstartstop`	boolean(0/1)	Optional Default: `0` Show start and stop messages from users.

POST Send Message `/chat`

https://rest.messengerpeople.com/api/v14/chat

Send a message to a user or to multiple users

Parameter	Type	Description
`id`	mixed	The user ID, number or secret hash code. Multiple IDs can be separated by comma. The user number / id must be numeric only. Do not add a "+" to the user number (WhatsApp)
`message`	string	Optional The text message to be send to the user. Sending an attachment with a message is only possible for image and video. Audio and document will ignore the message.
`attachment`	url	Optional The url of the attachment. The following types/extensions are supported: image (jpg, jpeg, png, gif), video (mp4, m4v, mpg, mpeg, mov, avi), audio (mp3) or document (pdf). If the attachment is valid, a field called `reusable_attachment` is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.
`filename`	string	Optional V7 The filename of the attachment. It can be displayed in messengers that don't support inline view of the attachment.
`conversation_status`	boolean(0/1)	Optional If set, mark the chat with this user as read (`1`) / unread (`0`).
`buttons`	json	Optional Buttons can be attached for all messengers except WhatsApp. A JSON encoded array of buttons can be passed. Each button must define a `caption` (displayed text), a `type` (link, postback, call or share) and an `info` field. Link must contain a URL. Postback a text send back to the server when the user clicks on it Call a phone number Share a link that can be shared (Facebook only) Example: `[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]`
`meta`	array	Optional V12 The parameter "meta" can contain any key => value pairs, that do not use reserved names. Mainly used for internal purposes
`batch_ids`	mixed	Optional V12 Array or comma-separated list of user numbers for sending to a larger number of users. Use instead of the id parameter. Performance-optimized so it does not update tickets of individual users. Just a list of success and failure numbers is returned.
`user_filter`	json	Optional V13 Optional filter to use for sending in batch mode. Valid filters are all parameters given in endpoint USER GET.

POST Send Notification `/chat/notification`

https://rest.messengerpeople.com/api/v14/chat/notification

Send a notification to a user or to multiple users in WhatsApp Business

Parameter	Type	Description
`id`	mixed	The user ID, number or secret hash code. Multiple IDs can be separated by comma.
`notification`	string	Optional V6 Deprecated The name of the notification
`parameters`	json	Optional V6 Deprecated A JSON array of parameters that are replaced in the notification
`language`	string	Optional V6 Deprecated ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter notification is set
`batch_ids`	mixed	Optional V12 Array or comma-separated list of user numbers for sending to a larger number of users. Use instead of the id parameter. Performance-optimized so it does not update tickets of individual users. Just a list of success and failure numbers is returned.
`user_filter`	json	Optional V13 Optional filter to use for sending in batch mode. Valid filters are all parameters given in endpoint USER GET.
`notification_template`	string	V12 The name of the notification template
`notification_body_variables`	json	Optional V12 A JSON array of parameters that are replaced in the notification. For example: ["$profile_name$", "Value 2"]
`notification_header_media`	string	Optional V12 The url of the header attachment. The following types/extensions are supported: image (jpg, png), video (mp4) or document (pdf). If the attachment is valid, a field called `reusable_attachment` is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.
`notification_header_variable`	string	Optional V12 The text to be placed into the header variable
`notification_button_variable`	string	Optional V13 The suffix added to a dynamic link button
`notification_language`	string	V12 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter notification_template is set. All available Language Codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates.

POST Bot Chat `/chat/bot`

https://rest.messengerpeople.com/api/v14/chat/bot

Start a bot conversation with a user by sending a botchat. bot_active of the associated ticket will be set and the bot topic will be set. Conditions of the bot chat will not be evaluated. The first block of answer(s) will be used.

Parameter	Type	Description
`id`	mixed	The user ID, number or secret hash code. Multiple IDs can be separated by comma.
`topic_id`	integer	Optional The ID of the topic
`chat_id`	integer	Optional The ID of the chat
`customfields`	json	Optional V7 JSON with `field name` => `field value`pairs which will be set as user properties before sending. see possible user properties by using the GET USER PROPERTIES call. Example: `{ "color": "red" }`

DELETE Delete /chat
https://rest.messengerpeople.com/api/v14/chat
Soft delete a single incoming chat by overwriting its text and remove all attachments

Parameter Value Type Description

id integer
The id of the chat that should be deleted
Request
Response

Parameter	Value	Type	Description
`id`		integer	The id of the chat that should be deleted

channel

GET Details /channel
https://rest.messengerpeople.com/api/v14/channel
Get basic information of the channel, that can be modified
This method has no parameters.
Request
Response

PUT Details `/channel`

https://rest.messengerpeople.com/api/v14/channel

Update basic information of the channel

Parameter	Type	Description
`name`	string	Optional New name of the channel
`statusmessage`	string	Optional Status message of the channel
`welcomemessage`	string	Optional Welcome message for new users
`new_ticket_message`	string	Optional V11 Ticket message for existing users
`read_confirmation`	boolean(0/1)	Optional Set if a read confirmation should be sent in WhatsApp when receving chat messages
`linkpreview`	boolean(0/1)	Optional Set to enable the linkpreview-feature in WhatsApp and Telegram
`every_word_starts`	boolean(0/1)	Optional Set to interpret every word as "Start" message. When disabled, only the default start word in the channels language or the specific start word is active.
`startword`	string	Optional When `startword` is set and `every_word_starts` is set to `0`, users are only activated if they send this specific word
`timezone`	string	Optional V2 The timezone, e.g. "Europe/Berlin" or "America/Los_Angeles"
`inactive_delete_timeout`	integer	Optional V2 The amount of days after which inactive users are deleted automatically
`language`	string	Optional V2 Default language for this channel. Possible languages: `de`, `en`, `d1` (formal German), `es`, `fr`, `it`, `nl`, `pl`, `pt`, `ru`, `r1`, `ar`, `tr`, `hr` and `jp`
`image`	url	Optional V2 URL of the profile image of the channel
`ticket_overdue_time`	integer	Optional V2 Time in minutes after which a ticket is marked as "overdue"
`ticket_critical_time`	integer	Optional V2 Time in minutes after which a ticket is marked as "critical"
`ticket_open_if_bot`	boolean(0/1)	Optional V5 Set if you want to open a ticket even if the chatbot answered already.
`ticket_reopen_period`	integer	Optional V5 Time in minutes after which a ticket is reopened after it has been closed. Default 60
`ticket_auto_close_time`	integer	Optional V13 Time in minutes after which a ticket is closed automatically. Default 0
`ticket_use_autoroutes`	boolean(0/1)	Optional V6 Set if you want to use autorouting of tickets.
`ticket_auto_assign`	boolean(0/1)	Optional V6 Set if you want to assign tickets to agents automatically.
`ticket_assign_last_agent`	boolean(0/1)	Optional V6 Set if you want to assign a ticket automatically to a previously assigned agent.
`ticket_deactivate_bot`	integer	Optional V6 Set to 2 for automatically deactivating a bot when the agent sends a chat response or to 1 when a ticket is opened.
`ui_settings`	string	Optional V7 Any information in json format used by a frontend to store channel specific settings
`ticket_max_per_agent`	integer	Optional V8 The maximum number of tickets that are assigned to an agent by auto routing.
`ticket_assign_online_agent`	boolean(0/1)	Optional V8 Set if you want to assign a ticket automatically only to online agents.
`applepay_settings`	string	Optional V8 Configuration for apple payment in json format
`enable_urltracking`	boolean(0/1)	Optional V10 Set if you want to enable urltracking with shortened URLs. Contact MessengerPeople if you want to use your own domain instead of www.msgp.pl.
`urltracking_parameters`	string	Optional V10 Parameters that are added to linked URLs if a user clicks on the link. %SOURCE% will be replaced by the used messenger
`categories_info_in_welcome`	boolean(0/1)	Optional V10 Set if you want to add the categories info to the welcome message.
`categories_info`	string	Optional V10 The categories info that can be added to the welcome message. %LINK% will be replaced by a user specific link
`use_content_notifications`	boolean(0/1)	Optional V10 Specifies whether notifications are used when sending content.
`content_pull_num`	integer	Optional Default: `5` V10 The number of unread information messages a user gets when requesting informations.
`content_pull_time`	integer	Optional V10 The maximum age in seconds of unread information messages a user gets when requesting informations.
`content_notifications`	string	Optional V10 An array of default texts that can be used when sending information
`content_pulled_all`	string	Optional V10 The message that a user gets when he tries to pull content but got already all content.
`content_pull_hint`	string	Optional V10 The message that a user gets in Whatsapp in addition to a notification informing how to pull the content. {{1}} is replaced by the pull keyword.
`notify_installed`	string	Optional V10 The initial text that an iOS user will send after installing the Notify app.
`notify_image`	string	Optional V10 The image displayed in the Notify app for the channel.
`notify_description`	string	Optional V10 A short text describing your channel visible in the Notify app.
`notify_chat`	boolean(0/1)	Optional V11 Specifies whether channel content can be displayed in the chat of Notify.
`notify_status`	string	Optional V10 The status of the channel in the Notify app affecting the visibility in the categories list. Possible values are public, private or hidden.
`promo`	string	Optional V11 Additional Notify promotion text to send only to WhatsApp users without the Notify app.
`welcomemessage_mia`	string	Optional V12 Welcome message for users subscribing for MIA content
`welcomemessage_mia_notify`	string	Optional V12 Notify promotion text added to for WhatsApp users subscribing for MIA content
`goodbye_message`	string	Optional V12 Goodbye message for users who are unsubscribing
`privacy_link`	string	Optional V12 Link to the privacy manifest
`mia_push`	boolean(0/1)	Optional V12 Specifies whether MIA content is pushed to messengers.
`deallocate_on_reopen`	boolean(0/1)	Optional V12 Specifies whether a reopened ticket should not be assigned to an agent. Default 0
`facebook_stop_timeout`	integer	Optional V12 The amount of days after which inactive Facebook users are stopped automatically
`notify_stop_timeout`	integer	Optional V12 The amount of days after which inactive Notify users are stopped automatically
`use_menu`	boolean(0/1)	Optional V12 Specifies whether the bot menu should be used.
`delete_chat`	boolean(0/1)	Optional V13 Specifies whether agents can delete single chat messages.
`mandatory_note_on_ticket_close`	boolean(0/1)	Optional Default: `0` V13 Specifies whether or not a note is mandatory on ticket close.

GET Chats `/channel/chats`

https://rest.messengerpeople.com/api/v14/channel/chats

Get the latest chat messages of the channel. With version 6 or higher addional information for outgoing chat is returned. Especially the send_status with the following possible values (availability depending on the messenger): 0 = sending in progress, 1 = sent (in WhatsApp and Viber 1= delivered), 2 = read, -1 = failed, -2 = user rejected, left the channel or 24 hour window is exceeded, 4 = Notification sent, 5 = Notification delivered, 6 = Notification read, -5 Notification failed, -6 Notification user does not exist

Parameter	Type	Description
`limit`	integer	Optional Default: `50` This is the amount of results that is returned.
`start`	integer	Optional ID of the first result to be served
`incoming`	boolean(0/1)	Optional Default: `1` Show incoming messages.
`outgoing`	boolean(0/1)	Optional Default: `1` Show outgoing messages.
`bot`	integer	Optional Default: `0` Show automated / bot messages if bot = 1. If bot = 2 include also welcome and stop messages.

GET Teams /channel/teams
https://rest.messengerpeople.com/api/v14/channel/teams
Get the teams of the channel
This method has no parameters.
Request
Response

POST Teams `/channel/teams`

https://rest.messengerpeople.com/api/v14/channel/teams

Create a new team for a channel

Parameter	Value	Type	Description
`name`		string	The name of the team
`add_agent`		mixed	Optional The ID of an agent that should be added to the team. Multiple IDs can be separated by comma.

PUT Teams `/channel/teams`

https://rest.messengerpeople.com/api/v14/channel/teams

Update teams of a channel

Parameter	Type	Description
`id`	mixed	The team ID. Multiple ids can be separated by comma.
`name`	string	Optional The name of the team
`add_agent`	mixed	Optional The ID of an agent that should be added to the team. Multiple IDs can be separated by comma.
`remove_agent`	mixed	Optional The ID of an agent that should be removed from the team. Multiple IDs can be separated by comma.

DELETE Teams /channel/teams
https://rest.messengerpeople.com/api/v14/channel/teams
Delete teams of a channel

Parameter Value Type Description

id mixed
The team ID. Multiple IDs can be separated by comma.
Request
Response
GET Agents /channel/agents
https://rest.messengerpeople.com/api/v14/channel/agents
Get the agents of the channel
This method has no parameters.
Request
Response
GET Online agent IDs /channel/online_agents
V13
https://rest.messengerpeople.com/api/v14/channel/online_agents
Get a list of ids of online agents of the channel
This method has no parameters.
Request
Response
GET Labels /channel/labels
https://rest.messengerpeople.com/api/v14/channel/labels
Get the labels of the channel
This method has no parameters.
Request
Response

Parameter	Value	Type	Description
`id`		mixed	The team ID. Multiple IDs can be separated by comma.

POST Labels `/channel/labels`

https://rest.messengerpeople.com/api/v14/channel/labels

Create a label for a channel

Parameter	Type	Description
`name`	string	The name of the label
`color_bg`	string	Optional The background color of the label in hex format, eg. `BADA55`
`color_tx`	string	Optional The text color of the label in hex format, eg. `C0FFEE`

PUT Labels `/channel/labels`

https://rest.messengerpeople.com/api/v14/channel/labels

Update a label of a channel

Parameter	Type	Description
`id`	mixed	The label ID. Multiple IDs can be separated by comma.
`name`	string	Optional The name of the label
`color_bg`	string	Optional The background color of the label in hex format, eg. `FACADE`
`color_tx`	string	Optional The text color of the label in hex format, eg. `BE1337`

DELETE Labels /channel/labels
https://rest.messengerpeople.com/api/v14/channel/labels
Delete labels of a channel

Parameter Value Type Description

id mixed
The label ID. Multiple IDs can be separated by comma.
Request
Response
GET Facebook /channel/facebook
https://rest.messengerpeople.com/api/v14/channel/facebook
Get Facebook connection info of the channel
This method has no parameters.
Request
Response

PUT Facebook `/channel/facebook`

https://rest.messengerpeople.com/api/v14/channel/facebook

Update Facebook confirmation and get-started information or (dis)connect to the Facebook page

Parameter	Type	Description
`confirm`	boolean(0/1)	Optional Default: `0` Set if a confirm dialog should be displayed to new Facebook users
`confirm_text`	string	Optional The text in the confirm dialog that new Facebook users are receiving.
`get_started`	boolean(0/1)	Optional Default: `0` Set if the Facebook "get started" button should be displayed to new users
`get_started_text`	string	Optional The greeting message that Facebook users are receiving when sending the first message to the page.
`access_token`	string	Optional The Facebook access token from an administrator connecting to a Facebook page. For connecting the page the `access_token`, `page_id` and `page_name` must be set. For disconnecting the page the `access_token` must be empty and `page_id` and `page_name` must be set.
`page_id`	integer	Optional The Facebook page ID
`page_name`	string	Optional The Facebook page name

DELETE Facebook /channel/facebook
https://rest.messengerpeople.com/api/v14/channel/facebook
Delete Facebook connection of a channel
This method has no parameters.
Request
Response
GET Webhook /channel/webhook
https://rest.messengerpeople.com/api/v14/channel/webhook
Get current webhook settings
This method has no parameters.
Request
Response

PUT Webhook `/channel/webhook`

https://rest.messengerpeople.com/api/v14/channel/webhook

Activate / Deactivate / Test Webhook An active WebHook will be used to inform an external system whenever a new chat message is sent from a user to a channel.

Parameter	Type	Description
`webhook_url`	url	The URL of a webhook. All incoming messages will be pushed to this URL. It MUST return a JSON `{ "success": "true" }` Otherwise the webhook will be deactivated after some failed attempts.
`status`	boolean(0/1)	Optional Set active (`1`) or inactive (`0`).
`webhook_email`	email	In case anything goes wrong, a notification will be sent to this email address.
`webhook_fields`	string	Optional V13 Comma separated list of fields to be included in the webhook call. Possible fields: id messenger usernumber date attachment attachment_type text welcome channelnumber userstatus chat_id bot_chatid is_retry Default: "id,messenger,usernumber,date,attachment,attachment_type,text,welcome,channelnumber,userstatus,chat_id"
`send_test`	boolean(0/1)	Optional A test message is sent to the webhook to check whether everything works correctly. The push contains three messages (2 x WhatsApp, 1 x Facebook) in one call: { "messages":[ { "id":"62103206", "messenger":"WB", "usernumber":"4917212345678", "date":"1522938174", "attachment":"", "attachment_type":"", "text":"Usermessage 1", "welcome":"0", "channelnumber":"4915792312345", "userstatus":"1", "chat_id":"1234567", "bot_chatid":"12345", "is_retry":"1" }, { "id":"62103207", "messenger":"WB", "usernumber":"4917212345678", "date":"1522938174", "attachment":"", "attachment_type":"", "text":"Usermessage 2", "welcome":"0", "channelnumber":"4915792312345", "userstatus":"1", "chat_id":"1234568", "bot_chatid":"12345", "is_retry":"0" }, { "id":"62103295", "messenger":"FB", "usernumber":"998694828505", "date":"1522938208", "attachment":"", "attachment_type":"", "text":"message via facebook", "welcome":"0", "userstatus":"1", "chat_id":"1234569", "bot_chatid":"12345", "is_retry":"0" } ] } If the user is activated successfully by sending the chat, the field `welcome` has the value `1`. The field userstatus has the value `-1`, `0` or `1`. `-1`: The user sending the chat was delete `0`: The user sending the chat is inactive `1`: The user sending the chat is active If the parameter webhook_fields is set, the test data will be adjusted according to the field list

GET APIkey /channel/apikey
https://rest.messengerpeople.com/api/v14/channel/apikey
Get the channel specific API key. This API key is valid until a new one is generated.
This method has no parameters.
Request
Response
PUT APIkey /channel/apikey
https://rest.messengerpeople.com/api/v14/channel/apikey
Generate a new API key. The previous API key is automatically invalidated.
This method has no parameters.
Request
Response
GET Invoices /channel/invoices
https://rest.messengerpeople.com/api/v14/channel/invoices
Returns all invoices and payment URLs
This method has no parameters.
Request
Response
GET Features /channel/features
https://rest.messengerpeople.com/api/v14/channel/features
This method has no parameters.
Request
Response

GET History /newsletter
https://rest.messengerpeople.com/api/v14/newsletter
Get your recent newsletters

Parameter Value Type Description

limit integer
Optional Default: 50
This is the amount of results that is returned.
Request
Response

POST Send `/newsletter`

warning

warning This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/newsletter

Send a newsletter to users

Parameter	Type	Description
`message`	string	Optional The text message to be send to the user. Sending an attachment with a message is only possible for image and video. Audio and document will ignore the message.
`attachment`	url	Optional The url of the attachment. The following types/extensions are supported: image (jpg, jpeg, png, gif), video (mp4, m4v, mpg, mpeg, mov, avi), audio (mp3) or document (pdf). If the attachment is valid, a field called `reusable_attachment` is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.
`date`	datetime	Optional Time for sending in the timezone set for the channel. Leave empty if the newsletter should be send immediately. (Format `YYYY-mm-dd HH:ii`)
`category`	integer	Optional Number of a category as seen in the backend (1–10)
`targeting_id`	integer	Optional ID of a targeting list. Cannot be combined with category. If the category is also set, this setting will be ignored.
`buttons`	json	Optional V5 Buttons can be attached for all messengers except WhatsApp. A JSON encoded array of buttons can be passed. Each button must define a `caption` (displayed text), a `type` (link, postback, call or share) and an `info` field. Link must contain a URL. Postback a text send back to the server when the user clicks on it Call a phone number Share a link that can be shared (Facebook only) Example: `[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]`

DELETE Scheduled /newsletter
https://rest.messengerpeople.com/api/v14/newsletter
Delete a scheduled newsletter by ID

Parameter Value Type Description

id integer
The ID of the newsletter that should be deleted. Only scheduled newsletter can be deleted when sending hasn't started yet.
Request
Response
GET Category /newsletter/category
https://rest.messengerpeople.com/api/v14/newsletter/category
Get all categories
This method has no parameters.
Request
Response

Parameter	Value	Type	Description
`id`		integer	The ID of the newsletter that should be deleted. Only scheduled newsletter can be deleted when sending hasn't started yet.

PUT Category `/newsletter/category`

https://rest.messengerpeople.com/api/v14/newsletter/category

Rename category

Parameter	Value	Type	Description
`id`		integer	Optional The ID 1-10 of a category
`name`		string	Optional The new name of the category. Maximum length of the name is 100 characters.

POST Category /newsletter/category
https://rest.messengerpeople.com/api/v14/newsletter/category
Create a new category. Users are assigned if categories_auto_assign is enabled at the channel

Parameter Value Type Description

name string
Optional V9
The name of the new category. Maximum length of the name is 100 characters.
Request
Response
DELETE Category /newsletter/category
https://rest.messengerpeople.com/api/v14/newsletter/category
Delete a category

Parameter Value Type Description

id integer
Optional
The ID 1-10 of a category
Request
Response

Parameter	Value	Type	Description
`name`		string	Optional V9 The name of the new category. Maximum length of the name is 100 characters.

Notification Templates new in version 13

GET Get /templates/{name}
V13
https://rest.messengerpeople.com/api/v14/templates/{name}
Get a single template

Parameter Value Type Description

name string
The name of the template
Request
Response

POST Post `/templates`

V13

https://rest.messengerpeople.com/api/v14/templates

Create a new template

Parameter	Type	Description
`name`	string	The name of the template
`category`	string	The category of the template Valid values: 'ACCOUNT_UPDATE', 'PAYMENT_UPDATE', 'PERSONAL_FINANCE_UPDATE', 'SHIPPING_UPDATE', 'RESERVATION_UPDATE', 'ISSUE_RESOLUTION', 'APPOINTMENT_UPDATE', 'TRANSPORTATION_UPDATE', 'TICKET_UPDATE', 'ALERT_UPDATE', 'AUTO_REPLY'
`translations`	array	An array of translations with the following JSON structure. language and body_text are mandatory. Header parameter depend on the header type: [ "en_US": { "language": "en_US", "body_text": "Text of the notification with parameter {{1}}", "header_type": "TEXT", <- one of TEXT, MEDIA "header_text": "Header text with parameter {{1}}", "header_media_type": "IMAGE", <- one of IMAGE, DOCUMENT, VIDEO, LOCATION "footer_text": "Footer text", "buttons": [ { <- up to 3 QUICK_REPLY buttons OR a URL and/or PHONE_NUMBER button "type": "QUICK_REPLY", <- one of QUICK_REPLY, URL, PHONE_NUMBER "text": "Button caption", <- "url": "https://foo.com/{{1}}", <- only for type URL. Parameter is optional. "phone_number": "0123456789", <- only for type PHONE_NUMBER } ], "sample": { <- sample data that helps WhatsApp in reviewing the template "body_variables": [ <- one for each used body variable "My variable 1", ], "header_media": "URL of media file", "header_variable": "My header variable", "button_variable": "Variable for dynamic URL button", }, }
`visible_for_agents`	bool	In-App visibility of the template

PUT Update `/templates/{name}`

V13

https://rest.messengerpeople.com/api/v14/templates/{name}

Update a template

Parameter	Type	Description
`id`	integer	The id of the template
`name`	string	The name of the template. Can only be changed if all translations are still in status DRAFT.
`category`	string	The category of the template Valid values: 'ACCOUNT_UPDATE', 'PAYMENT_UPDATE', 'PERSONAL_FINANCE_UPDATE', 'SHIPPING_UPDATE', 'RESERVATION_UPDATE', 'ISSUE_RESOLUTION', 'APPOINTMENT_UPDATE', 'TRANSPORTATION_UPDATE', 'TICKET_UPDATE', 'ALERT_UPDATE', 'AUTO_REPLY' Can only be changed if all translations are still in status DRAFT.
`translations`	array	An array of translations with the following JSON structure. language and body_text are mandatory. Header parameter depend on the header type: [ "en_US": { "id": 12345, <- ID of existing translation "language": "en_US", "body_text": "Text of the notification with parameter {{1}}", "header_type": "TEXT", <- one of TEXT, MEDIA "header_text": "Header text with parameter {{1}}", "header_media_type": "IMAGE", <- one of IMAGE, DOCUMENT, VIDEO, LOCATION "footer_text": "Footer text", "buttons": [ { <- up to 3 QUICK_REPLY buttons OR a URL and/or PHONE_NUMBER button "id": 12345, <- ID of existing button "type": "QUICK_REPLY", <- one of QUICK_REPLY, URL, PHONE_NUMBER "text": "Button caption", <- "url": "https://foo.com/{{1}}", <- only for type URL. Parameter is optional. "phone_number": "0123456789", <- only for type PHONE_NUMBER } ], "sample": { <- sample data that helps WhatsApp in reviewing the template "body_variables": [ <- one for each used body variable "My variable 1", ], "header_media": "URL of media file", "header_variable": "My header variable", "button_variable": "Variable for dynamic URL button", }, }]
`visible_for_agents`	bool	In-App visibility of the template

GET Validate template name /templates/{name}/validate-name
V13
https://rest.messengerpeople.com/api/v14/templates/{name}/validate-name
Check if a template name is not in use

Parameter Value Type Description

name string
The name of the template
Request
Response
GET Get template status /templates/{name}/review
V13
https://rest.messengerpeople.com/api/v14/templates/{name}/review
Get a list with review status for each language of a template

Parameter Value Type Description

name string
The name of the template
Request
Response

PUT Submit for Review `/templates/{name}/review`

V13

https://rest.messengerpeople.com/api/v14/templates/{name}/review

Submit all translations in status DRAFT to WhatsApp for review. Except those which are marked as skipped

Parameter	Type	Description
`id`	integer	The id of the template
`name`	string	The name of the template. Can only be changed if all translations are still in status DRAFT.
`category`	string	The category of the template Valid values: 'ACCOUNT_UPDATE', 'PAYMENT_UPDATE', 'PERSONAL_FINANCE_UPDATE', 'SHIPPING_UPDATE', 'RESERVATION_UPDATE', 'ISSUE_RESOLUTION', 'APPOINTMENT_UPDATE', 'TRANSPORTATION_UPDATE', 'TICKET_UPDATE', 'ALERT_UPDATE', 'AUTO_REPLY' Can only be changed if all translations are still in status DRAFT.
`translations`	array	An array of translations with the following JSON structure. language and body_text are mandatory. Header parameter depend on the header type: [ "en_US": { "id": 12345, <- ID of existing translation "skip": true, <- skip this translation from review "language": "en_US", "body_text": "Text of the notification with parameter {{1}}", "header_type": "TEXT", <- one of TEXT, MEDIA "header_text": "Header text with parameter {{1}}", "header_media_type": "IMAGE", <- one of IMAGE, DOCUMENT, VIDEO, LOCATION "footer_text": "Footer text", "buttons": [ { <- up to 3 QUICK_REPLY buttons OR a URL and/or PHONE_NUMBER button "id": 12345, <- ID of existing button "type": "QUICK_REPLY", <- one of QUICK_REPLY, URL, PHONE_NUMBER "text": "Button caption", <- "url": "https://foo.com/{{1}}", <- only for type URL. Parameter is optional. "phone_number": "0123456789", <- only for type PHONE_NUMBER } ], "sample": { <- sample data that helps WhatsApp in reviewing the template "body_variables": [ <- one for each used body variable "My variable 1", ], "header_media": "URL of media file", "header_variable": "My header variable", "button_variable": "Variable for dynamic URL button", }, }]
`visible_for_agents`	bool	In-App visibility of the template

GET Get translation /templates/{name}/translations/{lang}
V13
https://rest.messengerpeople.com/api/v14/templates/{name}/translations/{lang}
Get the translation for a translation of a template

Parameter Value Type Description

name string
The name of the template

lang string
The language of the translation
Request
Response
GET Get translation status /templates/{name}/translations/{lang}/review
V13
https://rest.messengerpeople.com/api/v14/templates/{name}/translations/{lang}/review
Get the review status for a single translation of a template

Parameter Value Type Description

name string
The name of the template

lang string
The language of the translation
Request
Response
DELETE Delete /templates/{name}
V13
https://rest.messengerpeople.com/api/v14/templates/{name}
Delete a template with all its translations. Note: You can not use the name of the deleted template to create a new one until the deletion is processed by Facebook

Parameter Value Type Description

name string
The name of the template

lang string
The language of the translation
Request
Response

Targeting Lists

GET List `/targeting`

https://rest.messengerpeople.com/api/v14/targeting

Get information about the available targeting lists

Parameter	Value	Type	Description
`id`		integer	Optional The ID of a single targeting list
`status`		boolean(0/1)	Optional V12 Status Filter. Use `1` for listing only targeting lists that dont use a status filter and `0` for listing targeting lists that filter inactive users.

PUT Update `/targeting`

https://rest.messengerpeople.com/api/v14/targeting

Update an existing targeting list

Parameter	Type	Description
`id`	integer	The targeting id
`name`	string	Optional The name of the targeting list
`query`	json	Optional A JSON array of the targeting list configuration

POST Create /targeting
https://rest.messengerpeople.com/api/v14/targeting
Create a new targeting list

Parameter Value Type Description

name string
The name of the targeting

query json
A JSON array of the targeting list configuration
Request
Response
DELETE Delete /targeting
https://rest.messengerpeople.com/api/v14/targeting
Delete an existing targeting list

Parameter Value Type Description

id integer
The ID of the targeting list
Request
Response
GET Configure /targeting/config
https://rest.messengerpeople.com/api/v14/targeting/config
Get the targeting configuration values
This method has no parameters.
Request
Response

GET Count `/targeting/count`

https://rest.messengerpeople.com/api/v14/targeting/count

Get count of users for a targeting list. To be used with one of the two parameters.

Parameter	Value	Type	Description
`id`		integer	Optional The targeting id
`query`		json	Optional The targeting query. Schema: {"query": { "condition": "OR", "rules": [{ "id": "rufnummer", "field": "rufnummer", "type": "string", "input": "text", "operator": "equal", "value": "1234" }]}}

GET Targeting Lists /targeting/user/{id}
V14
https://rest.messengerpeople.com/api/v14/targeting/user/{id}

Parameter Value Type Description

id integer
Optional
The targeting id

by_messenger bool(0/1)
Optional Default: 0
Result should be grouped by messenger
Request
Response

Channel Content

GET List `/content`

https://rest.messengerpeople.com/api/v14/content

Get information about the available content

Parameter	Type	Description
`id`	integer	Optional The ID of a single content.
`filter`	string	Optional List only drafts if filter = draft, scheduled if filter = scheduled or content that is already published if filter = published.
`limit`	integer	Optional Default: `50` This is the amount of results that is returned.
`offset`	integer	Optional Default: `0` This is the amount of results skipped in the result set.
`order`	string	Optional Content lists are ordered by published date per default (creation date for drafts). `created` can be specified to order by this attributes.
`asc`	boolean(0/1)	Optional Default: `0` Normally content lists are sorted descending which means latest first.
`clicks`	boolean(0/1)	Optional Default: `0` V10 Specifies whether click statistics should be returned for URLs in contents. Requires enabled click tracking in the channel. The result shows the total number of clicks and the number of clicks for each messenger.
`detailed_reach_stats`	boolean(0/1)	Optional Default: `0` V10 Specifies whether reach statistics should be additionally split up in 'pulled from' and 'pushed to' for each messenger separately.

GET MIA Targeting List /content/targeting
V14
https://rest.messengerpeople.com/api/v14/content/targeting
Get all targetings that can be used for sending MIA content. This includes all users, MIA topics and targeting lists with active users.
This method has no parameters.
Request
Response

POST Create `/content`

https://rest.messengerpeople.com/api/v14/content

Create a new content

Parameter	Type	Description
`text`	string	Optional The text of the content. Content with audio or document media will ignore the text.
`media`	url	Optional The url of a media attachment. The following types/extensions are supported: image (jpg, jpeg, png, gif), video (mp4, m4v, mpg, mpeg, mov, avi), audio (mp3) or document (pdf).
`media_filename`	string	Optional V11 The original filename of the attachment.
`draft`	boolean(0/1)	Optional If set, store the content as draft, otherwise it will be published.
`published`	integer	Optional The UNIX timestamp of the publication date in seconds (if not a draft). The current date is used per default.
`notification`	string	Optional V9 A short text that is sent to inform the users about new content. This text is sent to the Notify app or to WhatsApp, if the user has no Notify app.
`promo`	string	Optional V12 A special promotion text to be sent in a separate message with the content
`weblink`	string	Optional V9 If specified this link is opened directly from notifications in the Notify app. Other messengers will get the text + this weblink.
`buttons`	json	Optional V14 Buttons can be attached for all messengers except WhatsApp. A JSON encoded array of buttons can be passed. Each button must define a `caption` (displayed text), a `type` (link, postback, call or share) and an `info` field. Link must contain a URL. Postback a text send back to the server when the user clicks on it Call a phone number Share a link that can be shared (Facebook only) Example: `[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]`
`targeting`	integer	Optional V9 Category ID 1-10 or ID of a targeting list.
`lifetime`	integer	Optional V11 The lifetime of the content after publishing in seconds.
`pull_keyword`	integer	Optional V12 The id of the menu item holding the command that is used to pre-fill the users input field in WhatsApp in order to pull the content.
`wb_notification`	string	Optional V12 Deprecated The name of the WhatsApp notification used for sending
`wb_notification_parameters`	json	Optional V12 Deprecated A JSON array of parameters that are replaced in the WhatsApp notification
`wb_notification_language`	string	Optional V12 Deprecated ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter wb_notification is set
`notification_template`	string	Optional V12 The name of the notification template
`notification_body_variables`	json	Optional V12 A JSON array of parameters that are replaced in the notification
`notification_header_media`	string	Optional V12 The url of the header attachment. The following types/extensions are supported: image (jpg, png), video (mp4) or document (pdf). If the attachment is valid, a field called `reusable_attachment` is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.
`notification_header_variable`	string	Optional V12 The text to be placed into the header variable
`notification_button_variable`	string	Optional V13 The suffix added to a dynamic link button
`notification_language`	string	Optional V12 ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter notification_template is set

PUT Update `/content`

https://rest.messengerpeople.com/api/v14/content

Update an existing content

Parameter	Type	Description
`id`	integer	The content ID
`text`	string	Optional The text of the content. Content with audio or document media will ignore the text.
`media`	url	Optional The url of a media attachment. The following types/extensions are supported: image (jpg, jpeg, png, gif), video (mp4, m4v, mpg, mpeg, mov, avi), audio (mp3) or document (pdf).
`media_filename`	string	Optional V11 The original filename of the attachment.
`draft`	boolean(0/1)	Optional If set, store the content as draft, otherwise it will be published.
`published`	integer	Optional The UNIX timestamp of the publication date in seconds (if not a draft). The current date is used per default.
`notification`	string	Optional V9 A special notification text sent to the Notify app.
`promo`	string	Optional V12 A special promotion text to be sent in a separate message with the content
`weblink`	string	Optional V9 If specified this link is opened directly from notifications in the Notify app. Other messengers will get the text + this weblink.
`buttons`	json	Optional V14 Buttons can be attached for all messengers except WhatsApp. A JSON encoded array of buttons can be passed. Each button must define a `caption` (displayed text), a `type` (link, postback, call or share) and an `info` field. Link must contain a URL. Postback a text send back to the server when the user clicks on it Call a phone number Share a link that can be shared (Facebook only) Example: `[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]`
`targeting`	integer	Optional V9 Category ID 1-10 or ID of a targeting list.
`lifetime`	integer	Optional V11 The lifetime of the content after publishing in seconds.
`pull_keyword`	integer	Optional V12 The id of the menu item holding the command that is used to pre-fill the users input field in WhatsApp in order to pull the content.
`wb_notification`	string	Optional V12 Deprecated The name of the WhatsApp notification used for sending
`wb_notification_parameters`	json	Optional V12 Deprecated A JSON array of parameters that are replaced in the WhatsApp notification
`wb_notification_language`	string	Optional V12 Deprecated ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter wb_notification is set
`notification_template`	string	Optional V12 The name of the notification template
`notification_body_variables`	json	Optional V12 A JSON array of parameters that are replaced in the notification
`notification_header_media`	string	Optional V12 The url of the header attachment. The following types/extensions are supported: image (jpg, png), video (mp4) or document (pdf). If the attachment is valid, a field called `reusable_attachment` is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.
`notification_header_variable`	string	Optional V12 The text to be placed into the header variable
`notification_button_variable`	string	Optional V13 The suffix added to a dynamic link button
`notification_language`	string	Optional V12 ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter notification_template is set

PUT Stop Interaction /content/stopinteraction
https://rest.messengerpeople.com/api/v14/content/stopinteraction
Stop the interaction for a content with active interactions

Parameter Value Type Description

id integer
The content ID
Request
Response
DELETE Delete /content
https://rest.messengerpeople.com/api/v14/content
Delete an existing content

Parameter Value Type Description

id integer
The ID of the content.
Request
Response

Statistics

GET KPI Rules /statistics/kpi_rules
https://rest.messengerpeople.com/api/v14/statistics/kpi_rules
Get KPI access control rules defined for the channel
This method has no parameters.
Request
Response

GET Chat `/statistics/chats`

https://rest.messengerpeople.com/api/v14/statistics/chats

Get chat statistics

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET Tickets `/statistics/tickets`

https://rest.messengerpeople.com/api/v14/statistics/tickets

Get ticket statistics

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET Custom `/statistics/custom`

https://rest.messengerpeople.com/api/v14/statistics/custom

Get custom statistics

Parameter	Type	Description
`from`	int	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	int	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`kpi`	string	Optional Return only the given KPI, run without to see all KPIs
`source`	string	Specify the source of the statistics, expected values: chats, tickets
`interval`	string	Unit of period interval, expected values: hours, days, weeks
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET Bot `/statistics/bot`

https://rest.messengerpeople.com/api/v14/statistics/bot

Get bot statistics

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET MAU `/statistics/mau`

https://rest.messengerpeople.com/api/v14/statistics/mau

Get mau statistics

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`period`	string	Optional Default: `invoicing_period` Period of invoice, expected values: invoicing_period, last_invoicing_period If set, this will overrule the parameters 'from' and 'to'
`by_messenger`	bool	Optional Default: `false` Group monthly active users by messenger
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET MAU Details `/statistics/mau_details`

https://rest.messengerpeople.com/api/v14/statistics/mau_details

Get detailed mau statistics including user's chat times

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`period`	string	Optional Default: `invoicing_period` Period of invoice, expected values: invoicing_period, last_invoicing_period If set, this will overrule the parameters 'from' and 'to'
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET Content `/statistics/content`

https://rest.messengerpeople.com/api/v14/statistics/content

Get statistics about the number of reached users starting from 07.12.2019. The numbers are unique users per interval.

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`interval`	string	Unit of period interval, expected values: days, weeks, months
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET Agents `/statistics/agents`

https://rest.messengerpeople.com/api/v14/statistics/agents

Get statistics about all agents starting from 01.01.2020.
This feature must be activated by MessengerPeople.
Will return JSON:

"Agent Id"
- "absolute_tickets_closed"
- "absolute_tickets_involved"
- "outgoing_chats_in_ticket"
- "average_time_active_in_ticket"

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET Notifications `/statistics/notifications`

V13

https://rest.messengerpeople.com/api/v14/statistics/notifications

Get statistics about all send notifications. Will return JSON:

template
Name of the notification template
total
Number of notification sent (regardless of the status)
total_sent
Number of notifications sent (without failures)
total_failed
Number of notifications failed sending
total_undelivered
Number of notifications sent, but not jet received by the recipient
total_delivered
Number of notifications sent and received by the recipient
total_read
Number of notifications sent and read by the recipient

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET Labels `/statistics/labels`

V14

https://rest.messengerpeople.com/api/v14/statistics/labels

Get statistics about labels (tags) assigned to tickets.
This will return statistics by interval in the following JSON structure (note that an entry can have an empty body if no labels where used in this period):

{  
  "1606076985": { <- timestamp  
    "9482": { <- label id  
      "id": 9482, <- label id  
      "label": "example_label", <- label name  
      "color": "FF9300", <- label color HEX value  
      "count": 42 <- usage count for this period  
    }, ...  
  }  
}

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`interval`	string	Optional Default: `days` V14 Unit of period interval, expected values: days, weeks
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET Automation `/statistics/automation`

https://rest.messengerpeople.com/api/v14/statistics/automation

Get statistics about automation effects like chatbot usage and time savings

Parameter	Type	Description
`from`	integer	Optional Default: `0` UNIX timestamp of the start of the period, defaults to the last 30 days
`to`	integer	Optional Default: `0` UNIX timestamp of the end of the period, defaults to now
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET KPI Translations /statistics/kpi_translations
https://rest.messengerpeople.com/api/v14/statistics/kpi_translations
Get mapping of KPI name to understandable name in the language of the channel (or English if translation not available)
This method has no parameters.
Request
Response

Statistics (old)

GET Current /stats
https://rest.messengerpeople.com/api/v14/stats
Get current number of users in the channel
This method has no parameters.
Request
Response
GET Ticket /stats/ticket
https://rest.messengerpeople.com/api/v14/stats/ticket
Get ticket open / close statistics
This method has no parameters.
Request
Response

GET Ticket Details `/stats/ticketdetails`

https://rest.messengerpeople.com/api/v14/stats/ticketdetails

Get detailed statistics about tickets.
The following statistics data is provided for each time period:

opened: the number of opened tickets
closed: the number of closed tickets
average_opened: the average number of open tickets during the whole period
average_answer_time: the average response time for answers sent
average_close_time: the average time until a ticket is closed
average_answers: the average number of answers in closed tickets

The maximum number of results listed is 10000

Parameter	Type	Description
`unit`	string	Optional Default: `days` Specifies the unit of the result. Possible values are hours, days, weeks.
`start`	integer	Optional UNIX timestamp of the day/hour at which to start the statistics. Default: Current day for hour statistics, 30 days ago for days or weeks
`end`	integer	Optional UNIX timestamp at which to end the statistics. Default: current time
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

GET User `/stats/user`

https://rest.messengerpeople.com/api/v14/stats/user

Get user statistics of the channel

Parameter	Type	Description
`days`	boolean(0/1)	Optional Default: `1` Specifies whether day statistics should be returned. Default: 1 unless hour is set.
`hours`	boolean(0/1)	Optional Default: `0` Specifies whether hour statistics should be returned.
`start`	integer	Optional UNIX timestamp of the day/hour at which to start the statistics. Default: Current day for hour statistics, 30 days ago for days
`end`	integer	Optional UNIX timestamp at which to end the statistics. Default: current time
`output_format`	string	Optional Default: `json` Possible values json or csv.

GET Newsletter `/stats/newsletter`

warning

warning This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/stats/newsletter

Get newsletter statistics of the channel (since 2021-01-11 newsletters are no longer sent)

Parameter	Type	Description
`days`	boolean(0/1)	Optional Default: `1` Specifies whether day statistics should be returned. Default: 1 unless hour is set.
`hours`	boolean(0/1)	Optional Default: `0` Specifies whether hour statistics should be returned.
`start`	integer	Optional UNIX timestamp of the day/hour at which to start the statistics. Default: Current day for hour statistics, 30 days ago for days
`end`	integer	Optional UNIX timestamp at which to end the statistics. Default: current time
`clicks`	boolean(0/1)	Optional Default: `0` Specifies whether click statistics should be returned for URLs in the newsletters. Requires enabled click tracking in the channel. The result shows the total number of clicks and the number of clicks for each messenger.

GET Chat `/stats/chat`

https://rest.messengerpeople.com/api/v14/stats/chat

Get chat statistics of the channel

Parameter	Type	Description
`days`	boolean(0/1)	Optional Default: `1` Specifies whether day statistics should be returned. Default: 1 unless hour is set.
`hours`	boolean(0/1)	Optional Default: `0` Specifies whether hour statistics should be returned.
`start`	integer	Optional UNIX timestamp of the day/hour at which to start the statistics. Default: Current day for hour statistics, 30 days ago for days
`end`	integer	Optional UNIX timestamp at which to end the statistics. Default: current time
`bot`	boolean(0/1)	Optional Default: `0` V5 Include bot statistics.
`weeks`	boolean(0/1)	Optional Default: `0` V5 Include additional week statistics.

GET Bot `/stats/bot`

warning

warning This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/stats/bot

Get bot statistics of the channel

Parameter	Type	Description
`days`	boolean(0/1)	Optional Default: `1` Specifies whether day statistics should be returned. Default: 1 unless hour is set.
`hours`	boolean(0/1)	Optional Default: `0` Specifies whether hour statistics should be returned.
`start`	integer	Optional UNIX timestamp of the day/hour at which to start the statistics. Default: Current day for hour statistics, 30 days ago for days
`end`	integer	Optional UNIX timestamp at which to end the statistics. Default: current time

GET Content `/stats/content`

warning

warning This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/stats/content

Get statistics about number of reached users. The numbers are unique users per unit or during last 30 days. current_push the number of users that will be reached if a content is pushed now. For future usage.

Parameter	Type	Description
`start`	integer	Optional UNIX timestamp of the day/hour at which to start the statistics. Default: Current day for hour statistics, 30 days ago for days
`end`	integer	Optional UNIX timestamp at which to end the statistics. Default: current time
`unit`	string	Optional The unit of the returned statistics. Possible values are days, weeks or months. If the unit is omitted, only current_push and last_30days are returned.

Entities

GET Entity /entity/{id}
https://rest.messengerpeople.com/api/v14/entity/{id}
Get ID, name and attributes of entities.

Parameter Value Type Description

id integer
Optional
The entity ID.
Request
Response
GET Data /entity/{id}/data/{data_id}
https://rest.messengerpeople.com/api/v14/entity/{id}/data/{data_id}
Get entity data instances

Parameter Value Type Description

id integer
The entity ID

data_id integer
Optional
The entity data instance ID
Request
Response

POST Data `/entity/{id}/data/{data_id}`

https://rest.messengerpeople.com/api/v14/entity/{id}/data/{data_id}

Update or create an entity data instance

Parameter Value Type Description

id

integer

The entity ID

data_id

integer

Optional

The entity data instance ID, if the id is missing a new instance is created.

data

json

JSON with identifiers and attribute/value pairs for the object. Attributes which are not defined for the entity are ignored.
The keywords which identify the entitiy (in a message) are collected in the identifiers array. A keyword must not contain a ",".
Example:

{  
"identifiers": [  "john", "doe" ],  
"name": "John Doe",  
"mail": "john.doe@foo.bar"  
}

DELETE Data /entity/{id}/data/{data_id}
https://rest.messengerpeople.com/api/v14/entity/{id}/data/{data_id}
Delete an entity data instance

Parameter Value Type Description

id integer
The entity ID

data_id integer
Optional
The entity data instance ID
Request
Response

Widget Info

GET Widget /widget_info
https://rest.messengerpeople.com/api/v14/widget_info
Internal widget info

Parameter Value Type Description

id integer
Optional V3
The widget ID. If omitted return old widgets, if 0 return all new widgets, otherwise just the widget with that ID.
Request
Response

POST Widget `/widget_info`

https://rest.messengerpeople.com/api/v14/widget_info

Create new widget

Parameter	Type	Description
`name`	string	The widget name.
`widget_type_id`	integer	Optional The type ID of the widget
`title`	string	Optional The widget title
`body`	string	Optional The widget body text
`privacy_check`	boolean(0/1)	Optional Specifies whether a privacy check is displayed.
`privacy_text`	string	Optional The widget privacy text.
`privacy_link`	string	Optional The widget privacy link.
`messengers`	json	Optional Requires JSON with a list of messengers used in the widget. info and link_text are optional Example: `[ { "id": "WA", "link_text": "Please save the number", "info": "Please add the number to your contacts" } ]`
`settings`	json	Optional Requires JSON with a list of settings used in the widget. requires id and value Example: `[ { "id": 1, "value": "FFFFAA" }, { "id": 5, "value": 14 } ]`
`language`	string	Optional V7 Wdiget language. Per default the channel language is used. `de`, `en`, `es`, `fr`, `it`, `nl`, `pl`, `pt`, `ru`, `ar`, `tr`, `hr` and `jp`

PUT Widget `/widget_info/{id}`

https://rest.messengerpeople.com/api/v14/widget_info/{id}

Update a widget

Parameter	Type	Description
`id`	integer	The widget ID
`name`	string	Optional The widget name
`widget_type_id`	integer	Optional The type ID of the widget
`title`	string	Optional The widget title
`body`	string	Optional The widget body text
`privacy_check`	boolean(0/1)	Optional Specifies whether a privacy check is displayed.
`privacy_text`	string	Optional The widget privacy text
`privacy_link`	string	Optional The widget privacy link
`messengers`	json	Optional Requires JSON with a list of messengers used in the widget. info, link_text and sequence are optional Example: `[ { "id": "WA", "link_text": "Please save the number", "info": "Please add the number to your contacts", "sequence": 1, } ]`
`settings`	json	Optional Requires JSON with a list of settings used in the widget. requires id and value Example: `[ { "id": 1, "value": "FFFFAA" }, { "id": 5, "value": 14 } ]`
`language`	string	Optional V7 Wdiget language. Per default the channel language is used. `de`, `en`, `es`, `fr`, `it`, `nl`, `pl`, `pt`, `ru`, `ar`, `tr`, `hr` and `jp`

DELETE Widget /widget_info
https://rest.messengerpeople.com/api/v14/widget_info
Delete a widget

Parameter Value Type Description

id integer
The widget ID
Request
Response
GET Widget Settings /widget_info/settings
https://rest.messengerpeople.com/api/v14/widget_info/settings
Internal widget settings

Parameter Value Type Description

language string
Optional V7
Wdiget language. Per default the channel language is used.
de, en, es, fr, it, nl, pl, pt, ru, ar, tr, hr and jp
Request
Response

POST Widget Settings `/widget_info/settings`

https://rest.messengerpeople.com/api/v14/widget_info/settings

Create new internal widget settings

Parameter	Value	Type	Description
`name`		string	The widget setting name
`type`		string	Optional Default: `string` The widget settings data type. Possible values are `int`, `boolean`, `float`, `string`, `color`.

PUT Widget Settings `/widget_info/settings/{id}`

https://rest.messengerpeople.com/api/v14/widget_info/settings/{id}

Update internal widget settings

Parameter	Type	Description
`id`	integer	The widget settings ID
`name`	string	Optional The widget settings name
`type`	string	Optional Default: `string` The widget settings data type. Possible values are `int`, `boolean`, `float`, `string`, `color`.

DELETE Widget Settings /widget_info/settings/{id}
https://rest.messengerpeople.com/api/v14/widget_info/settings/{id}
Delete internal widget settings

Parameter Value Type Description

id integer
The widget settings ID
Request
Response

ticket

GET Details `/ticket/{id}`

https://rest.messengerpeople.com/api/v14/ticket/{id}

Get information about a ticket or list all tickets

Parameter	Type	Description
`id`	mixed	Optional The ticket ID or user_id. Multiple ids can be separated by comma. If a user_id is specified the last ticket of that user is returned.
`limit`	integer	Optional This is the amount of results that is returned. If the given amount is 0 the api will fallback to 500. The maximum is 500 if chats of the tickets are listed or 5000 if no chats are listed.
`offset`	integer	Optional This is the amount of results skipped in the result set.
`order`	string	Optional Default: `id` Field to order the results by. Valid values are 'id', 'closed', 'created', 'status', 'messenger', 'waiting_since', 'label_names', 'agent'.
`asc`	boolean(0/1)	Optional Default: `1` Whether to order the results ascending.
`status`	integer	Optional The status of the tickets. 0 for closed tickets, 1 for opened tickets
`my`	boolean(0/1)	Optional Default: `0` List only tickets assigned to me or my team.
`user_id`	mixed	Optional The ID of a user or comma-separated list of IDs.
`agent_id`	mixed	Optional The ID of an agent or comma-separated list of IDs.
`label`	mixed	Optional The ID of a label or comma-separated list of IDs.
`bot`	boolean(0/1)	Optional Default: `1` List bot chat messages of the ticket.
`search`	string	Optional V6 A filter for searching tickets. Searches can be performed for ticket numbers, user ids, text in chat and notes. Only tickets of users are listed that match the search filter.
`messenger`	string	Optional V8 A filter for listing only tickets of users with this messenger. Valid values are 'WA', 'WB', 'FB', 'TG', 'IN', 'IM', 'VI'. (WA and WB are synonyms)
`num_chats`	integer	Optional Default: `100000` V6 The maximum number of chats that are listed for each ticket .
`waiting_since`	string	Optional V7 A filter for listing only open tickets that are waiting since the specified time. Format: 0 for getting all answered, 1 for getting all unanswered tickets or from-to, e.g. 0-1552389233 or 1552389233-0 .
`notes`	boolean(0/1)	Optional Default: `1` V7 Set to 0 to avoid listing notes of the ticket(s) when ID is not specified.
`new`	boolean(0/1)	Optional Default: `0` V7 List only new open tickets that have not been answered yet.
`newsletter`	boolean(0/1)	Optional Default: `0` V12 Include newsletters to tickets chat list.
`customfields`	boolean(0/1)	Optional Default: `0` V13 Include custom fields of the user to tickets.
`closed_in`	string	Optional V13 A filter for listing only closed tickets that are closed within the specified time. Format: from-to, e.g. 0-1552389233 or 1552389233-0 .
`last_chat`	boolean(0/1)	Optional Default: `0` V13 Include timestamps (last_in/last_out) for last inbound and outbound chat
`postponed_only`	boolean(0/1)	Optional Default: `0` V14 Only show postponed tickets
`hide_postponed`	boolean(0/1)	Optional Default: `0` V14 Hide tickets that are postponed to the future

GET Get ticket history /ticket/{user_id}/ticket_history
https://rest.messengerpeople.com/api/v14/ticket/{user_id}/ticket_history
Get all closed tickets for a given user

Parameter Value Type Description

user_id mixed
The ID of the user
Request
Response
PUT Open /ticket/{id}/open
https://rest.messengerpeople.com/api/v14/ticket/{id}/open
Get the open ticket for a user or create a new open ticket for the user

Parameter Value Type Description

id integer
The ID of a user.
Request
Response

PUT Close `/ticket/{id}/close`

https://rest.messengerpeople.com/api/v14/ticket/{id}/close

Close the specified ticket

Parameter	Type	Description
`id`	integer	The ID of a ticket or a user.
`note`	string	Optional A note added. The agent must be logged in.
`batch_ids`	mixed	Optional V13 Array or comma-separated list of ticket ids. Use instead of the id parameter.
`label_ids`	mixed	Optional V14 Array or comma-separated list of labels.

PUT Details `/ticket/{id}`

https://rest.messengerpeople.com/api/v14/ticket/{id}

Assign an agent or team to a ticket or remove the assignment

Parameter	Type	Description
`id`	integer	The ID of a ticket or a user.
`agent_id`	integer	Optional The ID of an agent, to sign this ticket to.
`team_id`	integer	Optional The ID of a team, to assign this ticket to.
`agent_email`	string	Optional V12 The email address of an agent, to assign this ticket to. Only works if agent id and team id are not set.
`bot_active`	boolean(0/1)	Optional V6 Set if you want to activate or deactivate the chatbot for a ticket. Only relevant if the chat for the ticket is locked.
`waiting_since`	int(1)	Optional V7 Mark a ticket as answered even if the user send the last chat by setting waiting_since to 0.
`batch_ids`	mixed	Optional V13 Array or comma-separated list of ticket ids. Use instead of the id parameter.
`postponed`	int	Optional V14 Timestamp to postpone the ticket(s) to.

PUT Label `/ticket/{id}/label/{label_id}`

https://rest.messengerpeople.com/api/v14/ticket/{id}/label/{label_id}

Assign a label to a ticket.
Since Version 13 you can update the label settings of multiple tickets by using batch_ids and label_ids instead of id and label_id.

Parameter	Type	Description
`id`	integer	Optional The ID of a ticket or a user
`label_id`	integer	Optional The ID of a label
`batch_ids`	mixed	Optional V13 Array or comma-separated list of ticket ids. Use instead of the id parameter.
`label_ids`	mixed	Optional V13 Array or comma-separated list of label ids. Use instead of the label_id parameter.

DELETE Label /ticket/{id}/label/{label_id}
https://rest.messengerpeople.com/api/v14/ticket/{id}/label/{label_id}
Delete assignment of a label to a ticket

Parameter Value Type Description

id integer
The ID of a ticket or a user

label_id integer
Optional
The ID of a label
Request
Response

POST Note `/ticket/{id}/note`

https://rest.messengerpeople.com/api/v14/ticket/{id}/note

Add a note to a ticket

Parameter	Type	Description
`id`	integer	The ID of a ticket
`note`	string	The note text
`agent_id`	integer	Optional Agent ID to use instead of the currently logged-in agent's ID

PUT Note /ticket/{id}/note/{note_id}
https://rest.messengerpeople.com/api/v14/ticket/{id}/note/{note_id}
Update a note of a ticket

Parameter Value Type Description

id integer
The ID of a ticket

note_id integer
The ID of a note to update

note string
The updated note text
Request
Response
DELETE Note /ticket/{id}/note/{note_id}
https://rest.messengerpeople.com/api/v14/ticket/{id}/note/{note_id}
Deletes a note of a ticket

Parameter Value Type Description

id integer
The ID of a ticket

note_id integer
The ID of a note to update
Request
Response

GET Statistics `/ticket/statistics`

https://rest.messengerpeople.com/api/v14/ticket/statistics

Get detailed statistical information on the specified ticket or all tickets created in the specified range and return them in csv format

TicketID: the ticket number
Username: the name of the user
Agent: the name of the current assigned agent
Created: the creation time of the ticket
Assigned: the time when the ticket has been assigned to the current agent
Closed: the time when the ticket has been closed
Forwarded: the time after which the ticket has been forwarded to a different agent
Botmessages: the number of bot messages sent while the ticket was opened or before the ticket was opened
Agentmessages: the number of agent messages sent while the ticket was opened
DurationChatWithBot: the total number of seconds the user had to wait until he got a response from a bot
DurationChatWithAgent: the total number of seconds the user had to wait until he got a response from an agent
TotalAnswerTime: the sum of the answer times both by agent and bot
FirstAgentResponseAfter: the number of seconds until the agents first responded to the user
AverageAgentResponse: the average number of seconds until the agent sent a response to the user considering every answer within the current assigment period.
FirstAnswerAfter: the number of seconds until the very first response to the user

Parameter	Type	Description
`id`	integer	Optional ID of a ticket to get statistics from
`start`	string	Optional UNIX timestamp of the day/hour after which tickets have been created. Default last 24 hours
`end`	string	Optional UNIX timestamp of the day/hour before tickets have been created
`limit`	integer	Optional Default: `500` This is the amount of results that is returned.
`offset`	integer	Optional Default: `0` This is the amount of results skipped in the result set.
`short_stats`	boolean[0\|1]	Optional If specified return only one line for each ticket with information about the last assigned agent even if multiple agents had been assigned.

agent

GET Agent Data /agent/{id}
https://rest.messengerpeople.com/api/v14/agent/{id}
Get information of an agent

Parameter Value Type Description

id integer
Optional
The ID of an agent. If omitted list all agents.
Request
Response

POST Agent Data `/agent`

https://rest.messengerpeople.com/api/v14/agent

Add a new agent

Parameter	Type	Description
`email`	string	The email address of the new agent.
`roles`	string	The role(s) of the agent. All agents must have a role. Multiple roles can be separated by `,`
`firstname`	string	Optional The first name of the agent. First name and/or last name must be set.
`lastname`	string	Optional The last name of the agent. First name and/or last name must be set.
`profile_image`	url	Optional URL of the profile image of the agent.
`notification`	boolean(1/0)	Set if the agent should receive email notifications when a ticket is assigned or for new chat messages in assigned tickets.
`all_channels`	boolean(1/0)	Optional Set if the agent has access to all channels.
`channels`	string	Optional One or more channel IDs the agent is assigned to. Will be ignored if all_channels is set.
`active`	boolean(1/0)	V2 Set if the agent is active and is able to work on tickets.
`cc_mail`	string	Optional A second email address that should receive the email with the login information.
`two_factor_userid`	string	Optional V13 A user ID registered in one of the account channels that is used for sending the code during 2-factor authentication

PUT Agent Data `/agent/{id}`

https://rest.messengerpeople.com/api/v14/agent/{id}

Update profile information of an agent

Parameter	Type	Description
`id`	integer	The ID of an agent.
`roles`	string	Optional The role(s) of the agent. All agents must have a role. Multiple roles can be separated by `,`
`firstname`	string	Optional The first name of the agent. First name and/or last name must be set.
`lastname`	string	Optional The last name of the agent. First name and/or last name must be set.
`profile_image`	url	Optional URL of the profile image of the agent.
`notification`	boolean(1/0)	Set if the agent should receive email notifications when a ticket is assigned, for new chat messages in assigned tickets or unassigned tickets for dispatcher.
`notification_delay`	integer	Optional Default: `10` V12 Delay between email notifications in minutes
`active`	boolean(1/0)	V2 Set if the agent is active and is able to work on tickets.
`all_channels`	boolean(1/0)	Optional Set if the agent has access to all channels.
`channels`	string	Optional One or more channel IDs the agent is assigned to. Will be ignored if all_channels is set.
`language`	string	Optional Agent frontend language. Possible values: `en`, `de`, `es`, `fr`, `ar`, `it`
`settings`	json	Optional V3 Requires JSON with any name => value pairs. Example: `{ "setting": "value" }` Delete a setting by setting the value as empty string.
`skills`	json	Optional V5 A JSON array of skill IDs to assign to this agent
`two_factor_userid`	string	Optional V13 A user ID registered in one of the account channels that is used for sending the code during 2-factor authentication

PUT Agent Status /agent/status
https://rest.messengerpeople.com/api/v14/agent/status
Set the status of the logged in agent
Parameter Value Type Description
status integer
Set the current online status for this agent.

0 = offline

1 = online (green)

2 = away / inactive (yellow)

3 = busy (red)
Request
Response
GET Temporary Token /agent/temporary/token
https://rest.messengerpeople.com/api/v14/agent/temporary/token
Get a temporary token for logging in with a second device. The token is valid for 10 minutes. The method is only usable by logged in agents.

Parameter Value Type Description

device_id string
Optional
The device id of the primary device
Request
Response
PUT Agent Password /agent/password
https://rest.messengerpeople.com/api/v14/agent/password
Change the password of the logged in agent

Parameter Value Type Description

old_password password
The old password of the agent

new_password password
The new password of the agent
Request
Response

Parameter	Value	Type	Description
`name`		string	The name of the targeting
`query`		json	A JSON array of the targeting list configuration

Parameter	Value	Type	Description
`id`		integer	The ID of a ticket or a user
`label_id`		integer	Optional The ID of a label

Parameter	Value	Type	Description
`old_password`		password	The old password of the agent
`new_password`		password	The new password of the agent

Base-URL