API documentation

The API key will be automatically saved in localStorage.

Base-URL


            https://rest.messengerpeople.com/api/v17/<endpoint>

Download Postman Collection

user

GET Profile `/user/{id}`

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

Get profile information 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` The maximum number of results.
`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` The number of skipped results.
`blocked`	boolean(0/1)	Optional V2 Set to `1` for listing only blocked users
`unreachable`	boolean(0/1)	Optional V16 Set to `1` for listing only unreachable 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 Default: `created` V15 User lists are ordered by creation date per default. `stopped`, `id`, `name`, `messenger`, `blocked`, `last_chat`, `last_in` or `last_out` 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` V15 Set if the time of the last user chat (incoming or outgoing) should be included. Retrieving the information costs more time.
`last_in`	boolean(0/1)	Optional Default: `0` V15 Set if the time of the last user chat (incoming) should be included. Retrieving the information costs more time.
`last_out`	boolean(0/1)	Optional Default: `0` V15 Set if the time of the last user chat (outgoing) should be included. Retrieving the information costs more time.
`last_message`	boolean(0/1)	Optional Default: `0` V15 Set if the last message (incoming or outgoing) should be included. Not available when using tickets.
`unread`	boolean(0/1)	Optional Default: `0` V15 Set if the number of unread incoming chat messages should be included. Not available when using tickets.
`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 List only users whose latest chats have been with the chatbot without a ticket
`output_format`	string	Optional Default: `json` V14 Possible values json or csv. Only applies for listing users.

Request

Response

PUT Update `/user/{id}`

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

Update properties of a user

Parameter Value Type Description

id

mixed

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

fields

json

V15

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

name: name of the user

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

{  
"name": "John Doe",  
"customfields": {  
"haircolor": "brown",  
"123": "premium"  
},  
}

unread

integer

Optional V15

Number of unread incoming chat messages. Not available when using tickets. Set 0 or the number of unread chat messages.
If unread is set for multiple users, the fields parameter is ignored. Also only the last message per user is marked as unread if unread is greater 1.

Request

Response

POST Upload CSV `/user/csv`

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

Bulk update users by uploading a csv file.

WhatsApp, Facebook and Telegram user can be created with the upload as well.

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 user, differs by messenger, for WhatsApp this would be the phone number messenger mandatory Identifier for the used messenger of the user. Possible values: CC for Custom Messenger, FB for Facebook, IM for IMessage, IG for Instagram, RC for RCS, TG for Telegram, VI for Viber, WB for WhatsApp, IN for Notify name Username Control fields: activated 1: user should be activated for newsletters, 0: user should be deactivated for newsletters blocked 1: user should be blocked, 0: user should be unblocked deactivated 1: user should be deactivated for newsletters, 0: user should be activated for newsletters deleted: 1: user should be deleted, 0: user should not be deleted Every user property of the channel listed by name

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 user, differs by messenger, for WhatsApp this would be the phone number
- messenger
  mandatory
  Identifier for the used messenger of the user. Possible values: CC for Custom Messenger, FB for Facebook, IM for IMessage, IG for Instagram, RC for RCS, TG for Telegram, VI for Viber, WB for WhatsApp, IN for Notify
- name
  Username
Control fields:
- activated
  1: user should be activated for newsletters, 0: user should be deactivated for newsletters
- blocked
  1: user should be blocked, 0: user should be unblocked
- deactivated
  1: user should be deactivated for newsletters, 0: user should be activated for newsletters
- deleted:
  1: user should be deleted, 0: user should not be deleted
Every user property of the channel listed by name

DELETE Delete `/user/{id}`

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

Delete the user and his chats. Chats and information about the user are deleted immediately after this call.

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/v17/user/{id}/start

Activate a user for newsletters.

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/v17/user/{id}/stop

Deactivate a user for newsletters.

Parameter	Value	Type	Description
`id`		mixed	The user ID, number or secret hash code. Multiple IDs can be separated by comma.

Request

Response

POST Create `/user`

https://rest.messengerpeople.com/api/v17/user

Create a new user for the specified messenger

Parameter	Type	Description
`id`	string	The phone number of the user without blanks or leading + or 0, e.g 491771234567
`messenger`	string	Must be set to WB for creating a WhatsApp Business user
`name`	string	Optional V16 Name of the user
`status`	integer	Optional V16 1 for activating the user for newsletters

Request

Response

GET Property `/user/property`

https://rest.messengerpeople.com/api/v17/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

Request

Response

PUT Property `/user/property`

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

Update a user property of 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.

Request

Response

User properties

GET Properties `/custom/{id}`

https://rest.messengerpeople.com/api/v17/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

POST Create `/custom`

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

Create 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 types: `number` `text` `word` `enum` `collection` `location` `date` `time`
`values`	string	Optional Possible values or conditions for this proeprty. e.g. `>=2 <=9` for type `number`. `a,b,c,d` for 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)	Property can be edited on the "profile page" by the user.
`label`	string	Display name of the property (also shown on users profile page)
`position`	integer	Optional V8 The position of the property. Per default it is added at the end.
`agent_visible`	boolean(0/1)	Optional Default: `1` V15 Property is only visible with appropriate rights (not for normal agents).
`agent_readonly`	boolean(0/1)	Optional Default: `0` V15 Property is read only for agents.
`hidden`	boolean(0/1)	Optional Default: `0` V8 Property is only read if the corresponding parameter is set.
`default_value`	string	Optional V12 Default value that is replaced if no value is stored in the user profile.

Request

Response

PUT Update `/custom`

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

Update 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 types: `number` `text` `word` `enum` `collection` `location` `date` `time`
`values`	string	Optional Possible values or conditions for this property. e.g. `>=2 <=9` for type `number`. `a,b,c,d` for 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)	Property can be edited on the "profile page" by the user.
`label`	string	Display name of the property (also shown on users profile page)
`position`	integer	Optional V8 The position of the property.
`agent_visible`	boolean(0/1)	Optional Default: `1` V15 Property is only visible with appropriate rights (not for normal agents).
`agent_readonly`	boolean(0/1)	Optional Default: `0` V15 Property is read only for agents.
`hidden`	boolean(0/1)	Optional Default: `0` V8 Property is only read if the corresponding parameter is set.
`default_value`	string	Optional V12 Default value that is replaced if no value is stored in the user profile.

Request

Response

DELETE Delete `/custom`

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

Delete a user property

Parameter	Value	Type	Description
`id`		mixed	The property ID or name

Request

Response

User-Chat

GET Chat Messages `/chat`

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

Get the chat messages of a user ordered by chat time latest first. The result includes the send_status with the following possible values (availability depending on the messenger):
0 = sending in progress
1 = sent (in WhatsApp and Viber
2 = delivered)
3 = read
-1 = failed
-2 = user rejected, left the channel or 24 hour window is exceeded

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 maximum number of results.
`showstartstop`	boolean(0/1)	Optional Default: `0` Show newsletter start and stop messages of users.

Request

Response

POST Send Message `/chat`

https://rest.messengerpeople.com/api/v17/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 sent.
`attachment`	string	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, wav, ogg, opus) or document (pdf, docx, etc). 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. Can also contain json for sending product lists.
`filename`	string	Optional V7 The filename of the attachment. It can be displayed in messengers that don't support inline view of the attachment.
`buttons`	json	Optional A JSON encoded array of buttons can be passed. Each button must define a `caption` (displayed text), a `type` (link or postback) and an `info` field Link must contain a URL. Postback a text send back to the server when the user clicks on it Example: `[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]` Note: Buttons are sent differently to the various messengers.
`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.
`schedule`	integer	Optional V16 The UNIX timestamp when scheduling the message. Sending immediately per default.

Request

Response

POST Send Notification `/chat/notification`

https://rest.messengerpeople.com/api/v17/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.
`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	V15 Language code of the notification, that should be send. All available language codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates.
`schedule`	integer	Optional V16 The UNIX timestamp when scheduling the message to one user. Sending immediately per default.

Request

Response

DELETE Delete `/chat`

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

Delete a single incoming chat by overwriting its text with "_chat_deleted" and removing all attachments

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

Request

Response

channel

GET Properties /channel
https://rest.messengerpeople.com/api/v17/channel
Get properties of the channel
This method has no parameters.
Request
Response

GET Chats `/channel/chats`

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

Get all chat messages of the channel ordered by chat time latest first.
The result includes the send_status with the following possible values (availability depending on the messenger):
0 = sending in progress, 1 = sent (in WhatsApp and Viber 2 = delivered), 3 = read, -1 = failed, -2 = user rejected, left the channel or 24 hour window is exceeded,
Sent notifications are marked with notification: true

Parameter	Type	Description
`limit`	integer	Optional Default: `50` The maximum number of results.
`start`	integer	Optional V16 List only chat messages with a smaller or bigger ID, depending on the sorting.
`chattime`	integer	Optional V15 List only chat messages with a chattime that is later.
`incoming`	boolean(0/1)	Optional Default: `1` Show incoming messages.
`outgoing`	boolean(0/1)	Optional Default: `1` Show outgoing messages.
`chatmeta`	boolean(0/1)	Optional Default: `0` V15 Include chat meta information
`search_string`	string	Optional V16 Only messages that contain this substring will be returned .
`bot`	integer	Optional Default: `0` Show automated / bot messages if bot = 1. If bot = 2 include also welcome and stop messages.
`asc`	boolean(0/1)	Optional Default: `0` V16 Sort list with earliest first.

Request

Response

GET Agents /channel/agents
https://rest.messengerpeople.com/api/v17/channel/agents
Get the agents of the channel
This method has no parameters.
Request
Response

GET Online agent IDs `/channel/online_agents`

https://rest.messengerpeople.com/api/v17/channel/online_agents

Get a list of ids of online agents of the channel

Parameter	Value	Type	Description
`other_channels`		boolean(0/1)	Optional Default: `0` V15 Get online agents from other channels of this account

Request

Response

GET Labels /channel/labels
https://rest.messengerpeople.com/api/v17/channel/labels
Get the labels (tags) of the channel
This method has no parameters.
Request
Response

POST Labels `/channel/labels`

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

Create a label (tag) 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`

Request

Response

GET Webhook /channel/webhook
https://rest.messengerpeople.com/api/v17/channel/webhook
Get current webhook settings
This method has no parameters.
Request
Response

PUT Webhook `/channel/webhook`

https://rest.messengerpeople.com/api/v17/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 ticket_id ticket_status agent_id 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. If the parameter webhook_fields is set, the test data will be adjusted according to the field list 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

Request

Response

Notification Templates

GET Details `/templates/{name}`

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

Get a single template. If the name is omitted all templates are listed.

Parameter	Value	Type	Description
`name`		string	Optional The name of the template
`synchronize`		bool	Optional Default: `false` Synchronize templates with WhatsApp before listing

Request

Response

POST Post `/templates`

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

Create a new template

Parameter	Type	Description
`name`	string	The name of the template. Only lowercase letters, numbers and underscores allowed.
`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

Request

Response

PUT Update `/templates/{name}`

https://rest.messengerpeople.com/api/v17/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

Request

Response

DELETE Delete `/templates/{name}`

https://rest.messengerpeople.com/api/v17/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 WhatsApp.

Parameter	Value	Type	Description
`name`		string	The name of the template
`lang`		string	The language of the translation

Request

Response

Content (Newsletters/Campaigns)

GET List `/content`

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

List 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", content that is already published if filter = "published", or published and scheduled content of today (timezone Europe/Berlin) if filter = "today".
`limit`	integer	Optional Default: `50` The maximum number of results.
`offset`	integer	Optional Default: `0` The number 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 attribute.
`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.
`external_content`	boolean(0/1)	Optional Default: `0` V16 Specifies whether external content should be included.
`detailed_user_stats`	boolean(0/1)	Optional Default: `0` V16 Specifies whether error statistics for targeted users should be displayed. For each content the errors and the failed users are listed

Request

Response

GET Targeting Groups /content/targeting
https://rest.messengerpeople.com/api/v17/content/targeting
Get all targeting groups that can be used for sending content. This includes all users, newsletter topics and targeting groups with active users.
This method has no parameters.
Request
Response

POST Create `/content`

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

Create a new content

Parameter	Type	Description
`text`	string	Optional The text of the content.
`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, wav, ogg, opus) or document (pdf, docx etc).
`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.
`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 A JSON encoded array of buttons can be passed. Each button must define a `caption` (displayed text), a `type` (link or postback) and an `info` field Link must contain a URL. Postback a text send back to the server when the user clicks on it Example: `[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]` Note: Buttons are sent differently to the various messengers.
`targeting`	integer	Optional V9 NewsletterTopic 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 pull keyword used for pulling the content in WhatsApp.
`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	V15 Language code of the notification, that should be send. All available language codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates.
`targeting_query`	json	Optional V15 A targeting query to be used instead of a targeting_id.
`resend_id`	integer	Optional V16 Resending to failed users of another content. Content can be adapted
`campaign_tag`	string	Optional V16 A string forwarded to connectivity API for enterprise analytics

Request

Response

PUT Update `/content`

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

Update an existing content. For published content only the lifetime can be changed.

Parameter	Type	Description
`id`	integer	The content ID
`text`	string	Optional The text of the content.
`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, wav, ogg, opus) or document (pdf, docx etc).
`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.
`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 A JSON encoded array of buttons can be passed. Each button must define a `caption` (displayed text), a `type` (link or postback) and an `info` field Link must contain a URL. Postback a text send back to the server when the user clicks on it Example: `[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]` Note: Buttons are sent differently to the various messengers.
`targeting`	integer	Optional V9 Newsletter Topic 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 pull keyword used for pulling the content in WhatsApp.
`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 V15 Language code of the notification, that should be send. All available language codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates.
`targeting_query`	json	Optional V15 A targeting query to be used instead of a targeting_id.
`campaign_tag`	string	Optional V16 A string forwarded to connectivity API for enterprise analytics

Request

Response

DELETE Delete `/content`

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

Delete an existing content that is not yet published

Parameter	Value	Type	Description
`id`		integer	The ID of the content.

Request

Response

Targeting Groups

GET List `/targeting`

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

Get information about the available targeting groups

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

Request

Response

PUT Update `/targeting`

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

Update an existing targeting group

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

Request

Response

POST Create `/targeting`

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

Create a new targeting group

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

Request

Response

DELETE Delete `/targeting`

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

Delete an existing targeting group

Parameter	Value	Type	Description
`id`		integer	The ID of the targeting group

Request

Response

GET Configuration /targeting/config
https://rest.messengerpeople.com/api/v17/targeting/config
Get the targeting configuration values
This method has no parameters.
Request
Response

GET Count `/targeting/count`

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

Get number of users for a targeting group. 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": "messenger", "field": "messenger", "type": "string", "input": "select", "operator": "equal", "value": "FB" }]}}

Request

Response

GET User `/targeting/user`

https://rest.messengerpeople.com/api/v17/targeting/user

Get user IDs of a targeting group by id or by query optionally grouped by messenger.

Parameter	Type	Description
`id`	integer	Optional The targeting id
`by_messenger`	bool(0/1)	Optional Default: `0` Group the result by messenger
`query`	json	Optional V15 The targeting query. Schema: {"query": { "condition": "OR", "rules": [{ "id": "messenger", "field": "messenger", "type": "string", "input": "select", "operator": "equal", "value": "FB" }]}}

Request

Response

Statistics

GET Chat `/statistics/chats`

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

Get overall statistics of chat messages

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.

Request

Response

GET Tickets `/statistics/tickets`

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

Get statistics of ticket usage

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.

Request

Response

GET Custom `/statistics/custom`

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

Get detailed statistics of different KPIs for tickets and chats

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.

Request

Response

GET Bot `/statistics/bot`

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

Get statistics on incoming messages that are answered by the bot.

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.

Request

Response

GET MAU `/statistics/mau`

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

Get statistics of monthly active users optionally grouped by messenger.

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.

Request

Response

GET Content `/statistics/content`

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

Get statistics about the number of reached users starting December 7th 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.

Request

Response

GET Agents `/statistics/agents`

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

Get statistics about all agents starting January 1st 2020.
This feature must be activated by MessengerPeople.
The output contains for each agent:

"Agent Id"
- "absolute_tickets_closed"
  Number of closed tickets
- "absolute_tickets_involved"
  Number of tickets where the agent was involved
- "outgoing_chats_in_ticket"
  Number of sent chat messages in the tickets
- "average_time_active_in_ticket"
  Average time spent for answering the tickets

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.

Request

Response

GET Notifications `/statistics/notifications`

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

Get statistics of all sent notifications. The output contains:

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.

Request

Response

GET Labels `/statistics/labels`

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

Get statistics about labels (tags) assigned to tickets.
Output example (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.

Request

Response

GET Automation `/statistics/automation`

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

Get statistics about automation effects like chatbot usage and the amount of time saved by those

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.

Request

Response

GET Clicks `/statistics/clicks`

https://rest.messengerpeople.com/api/v17/statistics/clicks

Get statistics about clicks on URLs. Click tracking must be activated

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
`source`	string	Optional Filter the source of the URLS used for the clicks. Possible values: chats, content
`order`	string	Optional Default: `time` Output order of the click information in descending order. Possible values: time, clicks
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

Request

Response

GET WhatsApp Conversations `/statistics/whatsapp_conversations`

https://rest.messengerpeople.com/api/v17/statistics/whatsapp_conversations

Get information about monthly WhatsApp conversations and costs since February 2022. Costs of the current month are updated every night

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

Request

Response

GET Conversations `/statistics/conversations`

V16

https://rest.messengerpeople.com/api/v17/statistics/conversations

Gets statistics of conversations by messenger

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
`interval`	string	Unit of period interval, expected values: days, months
`output_format`	string	Optional Default: `json` V14 Possible values json or csv.

Request

Response

GET Registered Agents `/statistics/registered_agents`

V16

https://rest.messengerpeople.com/api/v17/statistics/registered_agents

Get statistics of monthly registered agents and their login days

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.

Request

Response

Statistics (old)

GET Ticket Details `/stats/ticketdetails`

https://rest.messengerpeople.com/api/v17/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 listed tickets 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.

Request

Response

GET User `/stats/user`

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

Get user statistics with newsletter activation information for each period. Also for all used messenger.

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.

Request

Response

Entities

GET Entity `/entity/{id}`

https://rest.messengerpeople.com/api/v17/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/v17/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/v17/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": "[email protected]"  
}

Request

Response

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

https://rest.messengerpeople.com/api/v17/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

ticket

GET Details `/ticket/{id}`

https://rest.messengerpeople.com/api/v17/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 Default: `500` The number of results. The maximum is 500 if chats of the tickets are listed or 5000 if no chats are listed.
`offset`	integer	Optional The number of tickets skipped in the result set.
`order`	string	Optional Default: `id` Order the results by that field. Valid fields are 'id', 'closed', 'created', 'status', 'messenger', 'waiting_since', 'label_names', 'agent', 'last_chat', 'last_in', 'last_out'.
`asc`	boolean(0/1)	Optional Default: `1` Define whether to order the resulting tickets descending or 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 the calling agent or her 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', 'IG', 'RC. (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 newsletter content to the chat list of the tickets.
`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
`output_format`	string	Optional Set to 'csv' to export tickets as CSV file

Request

Response

GET Get ticket history `/ticket/{user_id}/ticket_history`

https://rest.messengerpeople.com/api/v17/ticket/{user_id}/ticket_history

Get all closed tickets of 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/v17/ticket/{id}/open

Get the open ticket for a user or create and open a ticket for the user

Parameter	Value	Type	Description
`id`		integer	The ID of a user.
`reopen`		boolean(0/1)	Optional Default: `1` V16 Reopen a closed ticket or create a new ticket.

Request

Response

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

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

Close a ticket

Parameter	Type	Description
`id`	integer	The ID of a ticket or a user.
`note`	string	Optional Add a note. Only possible if called by an agent.
`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.

Request

Response

PUT Update `/ticket/{id}`

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

Assign an agent or team to a ticket or remove the assignment. Or postpone a ticket or mark as answered.

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.

Request

Response

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

https://rest.messengerpeople.com/api/v17/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.

Request

Response

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

https://rest.messengerpeople.com/api/v17/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

GET Statistics `/ticket/statistics`

https://rest.messengerpeople.com/api/v17/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 timestamp of the ticket
Closed: the time when the ticket has been closed
DurationUntilClosed: the number of seconds between ticket creation and ticket closing
Usermessages: the number of user messages sent while the ticket was opened or before the ticket was opened if the bot answered
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 number of seconds the user chatted with the bot before the ticket was created
DurationUntilAssigned: the number of seconds between ticket creation and assignment to the agent
DurationUntilFirstResponse: the number of seconds until the agent first responded to the user
AverageResponseTime: the average number of seconds until the agent sent a response to the user
TotalResponseTime: the total number of seconds the user had to wait until he got a response from an agent

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.
`details`	boolean[0\|1]	Optional Default: `0` If specified return one line for each ticket and each assigned agent

Request

Response

GET Chat Statistics `/ticket/chatstatistics`

V17

https://rest.messengerpeople.com/api/v17/ticket/chatstatistics

Get detailed statistical information on chat messages of 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 timestamp of the ticket
Closed: the time when the ticket has been closed
Labels: the assigned label(s) of the ticket
ChatTime: the Unix timestamp of the chat message
ResponseTime: for outgoing messages the number of seconds since last incoming message
Outgoing: 0 for incoming message, 1 for outgoing
Bot: for outgoing messages 1 for bot messages, 0 for agent messages
Text: the message text
Media: the media file

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.
`technical`	boolean[0\|1]	Optional Default: `0` If 1 include technical messages like Satellite location updates or Satellite closed messages
`labels`	boolean[0\|1]	Optional Default: `0` If 1 include ticket labels
`outgoing_only`	boolean[0\|1]	Optional Default: `0` If 1 include only outgoing messages

Request

Response

Tickets

GET Export Ticket PDF `/tickets/{id}/pdf`

https://rest.messengerpeople.com/api/v17/tickets/{id}/pdf

Export PDF file with all ticket relevant data

Parameter	Type	Description
`id`	number	Optional The id of the ticket
`language`	string	Optional Default: `en` The output language. Possible values: 'en', 'de'
`as_link`	boolean(0/1)	Optional Default: `0` Result as JSON with the field pdf linking to an url
`hidden`	boolean(0/1)	Optional Default: `0` Include internal hidden user properties
`no_images`	boolean(0/1)	Optional Default: `0` Include image URLs instead of images

Request

Response

Skills

GET Skills `/skill/{id}`

https://rest.messengerpeople.com/api/v17/skill/{id}

Get all skills

Parameter	Value	Type	Description
`id`		int	Optional ID of the skill

Request

Response

Release Notes

Version 17

cleanup of all endpoints

Version 16

CHANNEL/CHATS GET add optional keyword filter
USER/PROPERTY GET output field limited_access changed to agent_visible, hidden and default_value field added
USER/CATEGORIES GET/PUT removed. Use GET/PUT /user/PROPERTY instead
USER GET when reading single user: placeholder output removed, customfields only with id and value. last_update instead of time. profile substructure removed
USER GET when listing multiple user: last_update added to customfields
USER GET csv export: The name and properties are no longer ISO-8856-1 encoded (leading to ? instead of other characters but left as they are)
LOGIN POST The channel list does not include channel details of the active channel any more
AGENT/ME GET Gets current logged in agent information, like the response of Login Post
AGENT/TWOFACTOR GET/POST/PUT/DELETE Two-factor status, activating, reactivating and deactivating
CHANNEL/CHATS, CHAT, TICKET GET author information added to chat
TICKET/OPEN PUT new parameter reopen
ACCOUNTING PUT new parameter cnpj added
ACCOUNTING/INFO GET/PUT two_factor_template, two_factor_channel and two_factor_email removed. 2-Factor Authentication happens now through standard authenticator apps
ACCOUNTING/PRICING GET new result format with new pricing models
ACCOUNTING/PRICING PUT new parameter pricing_model_id and payment_method_id
USER POST When creating a WhatsApp user, it is no longer checked whether the user is using WhatsApp.
USER GET new filter unreachable for listing only users who cannot be reached any more through the messenger
CHANNEL/CHATS GET permit ordering chats with earliest first
CHANNEL/LIST GET new endpoint to list base information for all channels an agent has access to (also the ones not assigned to)
BOT/SHOP GET usage_count is now an integer, when listing without fields, topic id and name are returned.
BOT/SHOP_TOPIC GET new endpoint to list all shopping related bot topics.
CONTENT/EXTERNAL POST New endpoint for storing externally sent content.
CONTENT POST New parameter resend_id for posting to failed content again.
CONTENT POST New parameter campaign_tag for enterprise analytics.
CONTENT GET New parameter external_content for including externally sent content and detailed_user_stats for displaying details on reached targeted users
STATISTICS/REGISTERED_AGENTS GET added
CUSTOM New parameter and field agent_readonly
SKILLS added
TICKET/STATISTICS GET new parameter details, parameter short_stats removed, output format changed

Version 15

USER POST when creating a user (also by sending a notification) the user is now deactivated for MIA
STATISTICS/WHATSAPP_CONVERSATIONS GET added
CHANNEL/INVOICES GET added invoice_type field (credit_note / invoice).
BOT GET/PUT removed
STATS/TICKET GET Added new parameter current.
CUSTOM GET Added new output values. agent_visible replacing limited_access and hidden for values that should not be displayed in user interfaces.
CUSTOM POST/PUT agent_visible replacing limited_access and new parameter hidden for values that should not be displayed in user interfaces.
TARGETING/USER GET added parameter query
TICKETS/PDF GET added parameter as_link and hidden, hidden user properties are only included if hidden is set
USER GET Change last_chat to both incoming and outgoing messages. Add last_in and last_out for specific output and sorting. Unread for getting additional information in channels without tickets.
USER PUT New parameter for setting whether messages are read. agent and add/removelabel fields are deprecated.
NEWSLETTER all endpoints removed
CHAT/NOTIFICATION POST Removed deprecated parameters notification, parameters and language
LOGIN POST removed parameter channel_type, permit email adress in parameter two_factor_userid
USER/NOTE POST removed
CHAT GET added chat meta information like send_error for failed sending
CONTENT GET if clicks are returned only messengers are listed that have clicks
CONTENT GET added filter "today" to get published and scheduled content of today
CHANNEL GET/PUT removed parameter/output katnachricht, katnachricht_link, promo, notify_installed, notify_installed_answer, use_content_notifications, use_menu
CHANNEL GET/PUT added parameter ticket_for_instagram_story and multi_channel_events
CHANNEL/CHATS GET keep sorting by chattime descending if the start parameter is used. New parameter chattime to filter chats after that time. Chat output list as array
CHANNEL/ONLINE_AGENTS GET added parameter other_channels to list online agents from other channels.
CONTENT POST/PUT removed parameter promo and deprecated parameters wb_notification, wb_notification_parameters and wb_notification_language
CONTENT POST/PUT added parameter targeting_query
CONTENT/STOPINTERACTION PUT removed
TEMPLATES/VALIDATE-NAME GET return json if the name is valid
STATS/NEWSLETTER GET removed
STATS/CONTENT GET removed
STATS/BOT GET removed
STATISTICS/KPI_RULES GET removed
STATISTICS/RCS_PROVIDER GET added
BOT/MENU removed
BOT/MENUITEM removed
BOT/MANUALANSWER renamed to chatblock
BOT/TOPICS GET added
AGENT POST chatname added
GDPR removed

Version 14

LOGIN POST Some response data has been removed that can be fetched with single requests. Here is a list of the removed properties and their corresponding endpoints:
- agents: /agent?open_tickets=1
- available_languages: /internal/translation
- customer_info: /accounting/info
- news: /internal/news
- stats: /stats/ticket
MESSENGER WhatsApp Setup POST/GET New parameter "setup_contact_type" and "setup_contact" to get informed about the setup process
ACCOUNTING Info GET Added all the info you previouslygot in the "customer_info" property from the login request
TRANSLATION GET Added a list of our available languages to the response of the translations request
TICKET Removed ticket stats property from all responses
USER Removed ticket stats property from all responses
CHANNEL Removed categories_auto_subscribe. Category subscription can be set as default value of the custom variable
CONTENT POST/PUT Added Buttons to Content
STATISTICS/LABELS GET Added label (tag) statistics
STATISTICS GET Added new parameter output_format csv
STATISTICS Tickets GET Removed KPIs average_chats_when_ticket_closed and average_duration_until_followup_agent_reactions
CHANNEL new property mandatory_label_on_ticket_close
STATISTICS KPI_Translations GET added
USER GET Added new parameter output_format csv
CONTENT/TARGETING GET new endpoint replacing NEWSLETTER/TARGETING
TARGETING/COUNT GET new endpoint replacing NEWSLETTER/TARGETING with count
MESSENGER GET New standard attribute caption for all messengers with a caption
AGENT New attribute and parameter chatname
USER POST for creating a WhatsApp Business user
CUSTOM GET new property hidden_in_ui for internally used properties
CHAT/BOT POST new parameter user_filter

Version 13

TICKET PUT Details/Close: New parameter "batch_ids" perform action on multiple tickets in one call
Agent PUT/GET Data: Removed field settings allows to store any agent specific settings. notification_endpoints
TICKET GET: Corrected full text search for tickets including now ticket notes
USER GET: New filter parameter to filter users by custom fields or change date of custoenm fields
BOT Manual Answers GET Substituted parameter "filter" with "status" and "personal"
BOT Manual Answers PUT/POST New parameter "status"
BOT Manual Answers PUT All parameters except "id" are optional now
CHAT POST New parameter "user_filter" to perform sending a chat to multiple users by filter instead of user ids
CHAT (NOTIFICATION) POST New parameter "user_filter" to perform sending a notification to multiple users by filter instead of user ids
CHANNEL GET/PUT: New channel setting ticket_auto_close_time
TICKET GET: New parameter customfields for adding the users customfields to tickets
ACCOUNTING Info PUT/GET: Configuration of two factor authentication
ACCOUNTING Two_Factor_Email PUT: Send email to agents for registering messenger for two factor authentication
AGENT PUT/GET: Configuration of two factor authentication
LOGIN POST: New error code if two factor authentication is active
CONTENT POST: New parameter notification_button_variable
CHAT NOTIFICATION POST: New parameter notification_button_variable
CHANNEL Webhook GET: Added info on last failure and pausing
CHANNEL Webhook GET/PUT: Added webhook fields settings
CHANNEL GET/PUT: New field delete_chat specifying whether agents can delete single chats
CHANNEL GET: New field use_dynamic_chatblocks specifying whether dynamic chat blocks are shown in the user interface
TEMPLATES New endpoints for managing WhatsApp Business message templates

Version 12

TARGETING GET: List settings for a specific targeting list (identified by id) or every targeting list of the current channel
TARGETING PUT: Update a specific targeting list
TARGETING POST: Create a new targeting list
TARGETING DELETE: Remove a targeting list
CHANNEL GET/PUT: New channel settings welcomemessage_mia, welcomemessage_mia_notify, goodbye_message. Removed content_pull_hint, facebook_stop_timeout, notify_stop_timeout, mia_wb_notification, use_menu
USER GET: New field for customfields "time" providing the timestamp of the last value change for the custom field
TICKET GET: New sorting parameter "agents"
TICKET PUT Details: New parameter "agent_email" to assign ticket to an agent by its email address
CONTENT POST/PUT: Parameter "published" now accepts UNIX timestamp format and date strings in the format "YYYY-mm-dd HH:ii"
CONTENT POST/PUT: New parameter "pull_keyword" to set the command that is prefilled in WhatsApp after redirection from Notify
CONTENT POST/PUT: New parameter "wb_notification", "wb_notification_parameters" and "wb_notification_language" for sending a WhatsApp notification as content
CONTENT GET: New field "pull_keyword" providing the ID of the pull command from the command menu
LOGIN POST: New field "next_invoice" under "customer_info", List available roles under "customer_info", removed Whatsapp migration info, data of non-active channel reduced
ACCOUNTING GET: New field "contract_start" giving the unix timestamp of the contract beginning
CHANNEL AGENT GET: List available roles
CHANNEL GET: Removed parameter wa_numbers
CHAT (NOTIFICATION) POST: New parameter batch_ids for sending too many users with improved performance, shorten links if configured for the channel
CHAT (NOTIFICATION) POST: New parameter language. The language is not taken from the users device anymore. If not provided, it defaults to the template's default language. If no default language set, it defaults to the channel language.
CHAT POST: Removed obsolete parameters push and linkpreview. Placeholder syntax like in the bot builer, e.g. $profile_name$
USER GET: The placeholder syntax is adapted to the syntax used in the bot builder
CUSTOM GET/POST/PUT: The default_value ist displayed and can be set

Version 11

CHANNEL GET/PUT: New channel settings. New ticket message for sending an alternative message to a returning customer after he opend a new ticket.
CHANNEL GET/PUT: New channel setting notify_chat. Replaces notify_whatsapp_only.
CHANNEL CONTENT GET New attribute "teaser_to" and "teaser_to_by_messenger" (if detailedReachStats = 1) that tells how many users have received the notification message.
CHANNEL CONTENT POST/PUT/GET New parameter "media_filename" for the original filename of the media file.
CHANNEL GET/PUT: New channel settings. Promo - will save a default promo message
CHANNEL GET: New channel setting: hidden_phone
CONTENT GET/PUT: New content field. Promo - will save a promo message to content and override the promo message in channel
TICKET HISTORY GET New endpoint "get_ticket_history" to get all closed tickets for a given user ID.
TICKET STATISTICS GET New endpoint "get_ticket_statistics" to get detailed statistical information on one or more tickets

Version 10

NOTIFICATIONS: New format for notifications (GET/PUT/POST), due to changes and implementation of Facebook API. Always returns full set of notifications.
BOT Manual Answers: Add ability to store original filename as attachment_filename.
CHANNEL GET/PUT: New channel settings. Channelname is replaced by name. The welcome message for newsletetr channels is stored as bot chat.
NEWSLETTER TARGETING GET: New option for listing ids cor content sending.
NEWSLETTER CATEGORY GET/POST/PUT/DELETE: New endpoint for managing categories.
CHANNEL CONTENT GET: New option for detailed reach stats for each messenger separately.

Version 9

LOGIN POST: Output ticket_reopen_period in minutes instead of seconds.
USER POST csv: Bulk update users via CSV file upload.

Version 8

STATS GET Ticket: The current hour/day/week is included.
BOT MENU/MENUITEM: New endpoints for managing bot messenger menus.
LOGIN POST/CHANNEL GET: Information on booked bot modules is included based on associate role.
LOGIN GET: Information for administrators on wa_policies_accepted.
CONTENT INTERACTION GET: New endpoint for getting interaction information.
CUSTOM: The position of custom fields can be modified.
CUSTOM GET: Filter for showing hidden fields.
CHANNEL GET/PUT : New channel configuration ticket_max_per_agent, applepay_settings.
ACCOUNTING INFO: New endpoints for getting and updating additional account info.
USER GET: Provide type of custom fields.
CUSTOM: New attribute "limited_access" to show custom field only to dispatchers and admins.

Version 7

LOGIN POST: The agent ticket IDs and statistics is included.
AGENT GET: A new parameter open_tickets permits listing the IDs of the open tickets and ticket statistics for an agent. The name is set as well.
TICKET GET: A new parameter for avoiding listing ticket notes. And waiting_since allows filtering open tickets.
TICKET PUT: A new parameter waiting_since for marking an open ticket as answered.
BOT TOPICS GET: A new parameter with_fields allows to check user properties used in api call, condition or chat and list them.
CHANNEL GET: The channel id is listed.
CHAT BOT POST : Customfields can be passed as parameters and will be stored as user properties. Additionally the bot interprets the chat so all conditions, multiple answers etc are evaluated
CHAT POST : A filename can be passed as parameter. It can be displayed in messengers that don't support inline view of the attachment.
CHAT GET/CHANNEL CHAT GET/TICKET GET: Outgoing chats have additional/changed format: email_created is changed to agent_id and agent_email for customer service channels and send_status is added. notification is set for sent WhatsApp notifications. unread is only set for incoming chats for the newsletter platform.
WIDGETINFO GET: The channel id is listed.
STATS GET Ticketdetails: New ticket statistics
CHANNEL GET/PUT : New channel configuration ui_settings, bot_parser_modules.

Version 6

SKILLS: A new endpoint for managing agent skills used for auto-routing of tickets
USER GET Details: When listing a single user: Insta users get the correct messenger IN (instead of WN) and the output field profile_image is renamed to image consistent to the lists of multiple users.
USER GET Details: When listing a single user: Insta users get the correct messenger IN (instead of WN) and the output field profile_image is renamed to image consistent to the lists of multiple users.
STATS GET User/Current: Insta users get the correct messenger IN (instead of WN).
TICKET GET : Insta users get the correct messenger IN (instead of WN).
CHANNEL GET/PUT : New channel configuration ticket_use_autoroutes, ticket_auto_assign, ticket_assign_last_agent.
TICKET PUT/GET : the bot_active status is displayed and can be changed.
CUSTOM PUT/POST/DELETE : correct types for returned values
CHAT BOT POST : a new endpoint for starting a bot conversation by sending bot chat
TICKET POST : new parameter search for searching tickets by ticket id, user id or chat
TICKET GET : new parameters for searching tickets and limiting the number chats.

Version 5

CONTENT: A new endpoint for managing information content (for future usage)
MESSENGER: A new endpoint for managing the messengers connected to the channel
CHANNEL GET: New output fields ticket_reopen_period, ticket_open_if_bot, use_content
CHANNEL GET facebook: New output field non_promotional_content (if content is used and Facebook approved the content)
STATS GET user: Information for each hour is returned even if there was no actvitiy during that hour
STATS GET chat: Information for each hour is returned even if there was no actvitiy during that hour
STATS GET content: A new endpoint for content statistics (for future usage)

Version 4

USER GET property: A new endpoint for getting a property of all or a list of users
USER PUT property: A new endpoint for setting efficiently a property of a list of users
CHANNEL GET apikey: A new endpoint for getting the current channel apikey
CHANNEL PUT apikey: A new endpoint for generating a new channel apikey

Version 3

Agent PUT/GET Data: A new field settings allows to store any agent specific settings. notification_endpoints show information on the agents browser notification settings
Bot GET chats: Output fields are corrected and with correct types
POST chat: The ticket ID is included in the response it the chat is assigned to a ticket
Newsletter GET Targeting: New optional parameters allow to list the number of users of the lists and to get that for just one targeting list

Version 2

User GET Details: New parameters are added to filter and sort the result. The result is now no longer a list with users but a structure with a "total" field with the total number of users matching the filter and a "user" field with the list of users. Each user entry has now additional fields: messenger, created and stopped (only for inactive users)
User GET Details: The output field name is only returned if the user has a name. The output field last_change is removed. The output field stopped shows the stop time instead if the user is stopped (like in the user list). Custom fields that are empty are no longer listed. Each custom field is now listed as a separate object with id, name and value. An output field external_id is returned for messengers like Facebook. Custom fields of type location contain now a structure with a name and location coordinates.
User PUT Details: The result for is now similar to the information in a GET call. All updates for custom fields are listed in a custom fields array. Custom field values are validated for their types. Custom fields of type location can now be set as well with just their location coordinates returning the name as well.
Widget: A new endpoint for getting widget information like available WhatsApp numbers
Channel-Teams: New functions for creating, updating, deleting and listing teams of a channel
Channel-Agents: A new function for listing the agents who have access to a channel
Channel-Labels: New functions for creating, updating, deleting and listing labels of a channel
Channel-Facebook: New functions for reading, creating, updating and deleting the Facebook connection of a channel
Ticket: New functions for creating, updating, deleting and listing tickets
Output Types: If a field represents an integer like timestamps, ids or numbers, it is returned as an integer and no longer as a string, e.g. "status": 1 instead of "status": "1"
Content-Type header: The encoding is now explicitly mentioned: Content-Type: application/json; charset=utf-8
Channel GET Details: An optional parameter wa_numbers allows to list all WhatsApp channel numbers. channelname is renamed to name.
Channel-Details: New fields can be read or updated like timezone or language
Stats GET Newsletters: The newsletter result field is now directly the array and not a structure newsletter: { "newsletter"
Stats GET Tickets: New statistics on tickets
Ticket: New functions for creating, updating, deleting and reading tickets
Agent: New functions for creating, updating, deleting and reading agent information
Login: New endpoint for logging in as a customer agent, sending a code for a forgotten password and logout an agent.
User Properties: New functions for creating, updating and deleting properties.
User Chat POST: Returns the chat ID now
Bot Status: New functions for reading and updating the bot status
Bot Absence Message: New functions for creating, updating, deleting and reading bot absence messages
Bot Manual Answer: New functions for creating, updating, deleting and reading manual answers available in the customer service product
Bot Chats: Get all defined bot chats